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 eval {do "$main::data/prefix_data.pl" if !$out; };
77 $lru = LRU->newbase('Prefix', $lrusize);
90 my $fh = new IO::File;
91 my $fn = "$main::data/prefix_data.pl";
93 confess "Prefix system not started" if !$db;
96 rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
97 rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
98 rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
99 rename "$fn.o", "$fn.oo" if -e "$fn.o";
100 rename "$fn", "$fn.o" if -e "$fn";
102 $fh->open(">$fn") or die "Can't open $fn ($!)";
104 # prefix location data
105 $fh->print("%prefix_loc = (\n");
106 foreach $l (sort {$a <=> $b} keys %prefix_loc) {
107 my $r = $prefix_loc{$l};
108 $fh->printf(" $l => bless( { name => '%s', dxcc => %d, itu => %d, utcoff => %d, lat => %f, long => %f }, 'Prefix'),\n",
109 $r->{name}, $r->{dxcc}, $r->{itu}, $r->{cq}, $r->{utcoff}, $r->{lat}, $r->{long});
111 $fh->print(");\n\n");
114 $fh->print("%pre = (\n");
115 foreach $k (sort keys %pre) {
116 $fh->print(" '$k' => [");
117 my @list = @{$pre{$k}};
124 $fh->print("$str ],\n");
131 # what you get is a list that looks like:-
133 # prefix => @list of blessed references to prefix_locs
135 # This routine will only do what you ask for, if you wish to be intelligent
136 # then that is YOUR problem!
144 return () if $db->seq($gotkey, $ref, R_CURSOR);
145 return () if $key ne substr $gotkey, 0, length $key;
147 return ($gotkey, map { $prefix_loc{$_} } split ',', $ref);
151 # get the next key that matches, this assumes that you have done a 'get' first
160 return () if $db->seq($gotkey, $ref, R_NEXT);
161 return () if $key ne substr $gotkey, 0, length $key;
163 return ($gotkey, map { $prefix_loc{$_} } split ',', $ref);
167 # put the key LRU incluing the city state info
172 my ($call, $ref) = @_;
174 my @s = USDB::get($call);
177 # this is deep magic, because this is a reference to static data, it
179 my $h = { %{$ref->[1]} };
180 bless $h, ref $ref->[1];
185 $ref->[1]->{city} = $ref->[1]->{state} = "" unless exists $ref->[1]->{state};
188 dbg("Prefix::lru_put $call -> ($ref->[1]->{city}, $ref->[1]->{state})") if isdbg('prefix');
189 $lru->put($call, $ref);
193 # search for the nearest match of a prefix string (starting
194 # from the RH end of the string passed)
202 for (my $i = length $pref; $i; $i--) {
204 my $s = substr($pref, 0, $i);
206 my $p = $lru->get($s);
209 if (isdbg('prefix')) {
210 my $percent = sprintf "%.1f", $hits * 100 / $misses;
211 dbg("Partial Prefix Cache Hit: $s Hits: $hits/$misses of $matchtotal = $percent\%");
213 lru_put($_, $p) for @partials;
218 if (isdbg('prefix')) {
219 my $part = $out[0] || "*";
220 $part .= '*' unless $part eq '*' || $part eq $s;
221 dbg("Partial prefix: $pref $s $part" );
223 if (@out && $out[0] eq $s) {
232 # extract a 'prefix' from a callsign, in other words the largest entity that will
233 # obtain a result from the prefix table.
235 # This is done by repeated probing, callsigns of the type VO1/G1TLH or
236 # G1TLH/VO1 (should) return VO1
241 my $calls = uc shift;
247 LM: foreach $call (split /,/, $calls) {
250 $call =~ s/-\d+$//; # ignore SSIDs
252 my $ecall = "=$call";
254 # first check if this is a call (by prefixing it with an = sign)
255 my $p = $lru->get($ecall);
258 if (isdbg('prefix')) {
259 my $percent = sprintf "%.1f", $hits * 100 / $misses;
260 dbg("Prefix Exact Cache Hit: $call Hits: $hits/$misses of $matchtotal = $percent\%");
266 # then check if the whole thing succeeds either because it is cached
267 # or because it simply is a stored prefix as callsign (or even a prefix)
268 $p = $lru->get($call);
271 if (isdbg('prefix')) {
272 my $percent = sprintf "%.1f", $hits * 100 / $misses;
273 dbg("Prefix Cache Hit: $call Hits: $hits/$misses of $matchtotal = $percent\%");
279 # is it in the USDB, force a matchprefix to match?
280 my @s = USDB::get($call);
283 @nout = matchprefix($call) unless @nout;
284 $nout[0] = $ecall if @nout;
287 # try a straight get for an exact callsign
291 # now store the exact prefix if it has been found
292 if (@nout && $nout[0] eq $ecall) {
295 lru_put("=$call", \@nout);
296 dbg("got exact prefix: $nout[0]") if isdbg('prefix');
301 # now try a non-exact call/prefix
302 if ((@nout = get($call)) && $nout[0] eq $call) {
304 lru_put($call, \@nout);
305 dbg("got exact prefix: $nout[0]") if isdbg('prefix');
310 # now split the call into parts if required
311 @parts = ($call =~ '/') ? split('/', $call) : ($call);
312 dbg("Parts: $call = " . join(' ', @parts)) if isdbg('prefix');
314 # remove any /0-9 /P /A /M /MM /AM suffixes etc
316 @parts = grep { !/^\d+$/ && !/^[PABM]$/ && !/^(?:|AM|MM|BCN|JOTA|SIX|WEB|NET|Q\w+)$/; } @parts;
318 # can we resolve them by direct lookup
319 my $s = join('/', @parts);
321 if (@nout && $nout[0] eq $s) {
322 dbg("got exact multipart prefix: $call $s") if isdbg('prefix');
324 lru_put($call, \@nout);
329 dbg("Parts now: $call = " . join(' ', @parts)) if isdbg('prefix');
331 # at this point we should have two or three parts
332 # if it is three parts then join the first and last parts together
335 # first deal with prefix/x00xx/single letter things
336 if (@parts == 3 && length $parts[0] <= length $parts[1]) {
337 @nout = matchprefix($parts[0]);
339 my $s = join('/', $nout[0], $parts[2]);
341 if (@try && $try[0] eq $s) {
342 dbg("got 3 part prefix: $call $s") if isdbg('prefix');
344 lru_put($call, \@try);
349 # if the second part is a callsign and the last part is one letter
350 if (is_callsign($parts[1]) && length $parts[2] == 1) {
356 # if it is a two parter
359 # try it as it is as compound, taking the first part as the prefix
360 @nout = matchprefix($parts[0]);
362 my $s = join('/', $nout[0], $parts[1]);
364 if (@try && $try[0] eq $s) {
365 dbg("got 2 part prefix: $call $s") if isdbg('prefix');
367 lru_put($call, \@try);
374 # remove the problematic /J suffix
375 pop @parts if @parts > 1 && $parts[$#parts] eq 'J';
379 @nout = matchprefix($parts[0]);
381 dbg("got prefix: $call = $nout[0]") if isdbg('prefix');
383 lru_put($call, \@nout);
392 L1: for ($n = 0; $n < @parts; $n++) {
395 for ($i = $k = 0; $i < @parts; $i++) {
396 next if $checked[$i];
398 if (!$sp || length $p < length $sp) {
399 dbg("try part: $p") if isdbg('prefix');
405 $sp =~ s/-\d+$//; # remove any SSID
407 # now start to resolve it from the right hand end
408 @nout = matchprefix($sp);
410 # try and search for it in the descriptions as
411 # a whole callsign if it has multiple parts and the output
412 # is more two long, this should catch things like
413 # FR5DX/T without having to explicitly stick it into
418 $parts[$k] = $nout[0];
419 my $try = join('/', @parts);
421 if (isdbg('prefix')) {
422 my $part = $try[0] || "*";
423 $part .= '*' unless $part eq '*' || $part eq $try;
424 dbg("Compound prefix: $try $part" );
426 if (@try && $try eq $try[0]) {
428 lru_put($call, \@try);
432 lru_put($call, \@nout);
437 lru_put($call, \@nout);
445 @nout = matchprefix('Q');
447 lru_put($call, \@nout);
451 if (isdbg('prefixdata')) {
452 my $dd = new Data::Dumper([ \@out ], [qw(@out)]);
459 # turn a list of prefixes / dxcc numbers into a list of dxcc/itu/zone numbers
473 if ($cmd ne 'ns' && $v =~ /^\d+$/) {
474 push @out, $v unless grep $_ eq $v, @out;
476 if ($cmd eq 'ns' && $v =~ /^[A-Z][A-Z]$/i) {
477 push @out, uc $v unless grep $_ eq uc $v, @out;
479 my @pre = Prefix::extract($v);
482 foreach my $p (@pre) {
483 my $n = $p->dxcc if $cmd eq 'nc' ;
484 $n = $p->itu if $cmd eq 'ni' ;
485 $n = $p->cq if $cmd eq 'nz' ;
486 $n = $p->state if $cmd eq 'ns';
487 push @out, $n unless grep $_ eq $n, @out;
496 # get the full country data (dxcc, itu, cq, state, city) as a list
502 my @dxcc = extract($call);
504 my $state = $dxcc[1]->state || '';
505 my $city = $dxcc[1]->city || '';
506 my $name = $dxcc[1]->name || '';
508 return ($dxcc[1]->dxcc, $dxcc[1]->itu, $dxcc[1]->cq, $state, $city, $name);
510 return (666,0,0,'','','Pirate-Country-QQ');
514 lat => '0,Latitude,slat',
515 long => '0,Longitude,slong',
522 utcoff => '0,UTC offset',
523 cont => '0,Continent',
529 my $name = $AUTOLOAD;
531 return if $name =~ /::DESTROY$/;
534 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
535 # this clever line of code creates a subroutine which takes over from autoload
536 # from OO Perl - Conway
537 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}} ;
542 # return a prompt for a field
547 my ($self, $ele) = @_;