remove any leading ::ffff: on ipv4 addresses
[spider.git] / perl / DXUtil.pm
index b329f51bd7d62e1b3c2de5c4c5b6f6831153a6c1..157ff609534515009faf6ff07914e690784fd349 100644 (file)
@@ -3,34 +3,31 @@
 #
 # Copyright (c) 1998 - Dirk Koopman G1TLH
 #
-# $Id$
+#
 #
 
 package DXUtil;
 
+
 use Date::Parse;
 use IO::File;
 use File::Copy;
 use Data::Dumper;
+use Time::HiRes qw(gettimeofday tv_interval);
 
 use strict;
 
-use vars qw($VERSION $BRANCH);
-$VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
-$BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/  || (0,0));
-$main::build += $VERSION;
-$main::branch += $BRANCH;
-
-use vars qw(@month %patmap @ISA @EXPORT);
+use vars qw(@month %patmap $pi $d2r $r2d @ISA @EXPORT);
 
 require Exporter;
 @ISA = qw(Exporter);
 @EXPORT = qw(atime ztime cldate cldatetime slat slong yesno promptf 
-                        parray parraypairs phex shellregex readfilestr writefilestr
+                        parray parraypairs phex phash shellregex readfilestr writefilestr
                         filecopy ptimelist
              print_all_fields cltounix unpad is_callsign is_latlong
                         is_qra is_freq is_digits is_pctext is_pcflag insertitem deleteitem
-                        is_prefix dd
+                        is_prefix dd is_ipaddr $pi $d2r $r2d localdata localdata_mv
+                        diffms
             );
 
 
@@ -42,6 +39,11 @@ require Exporter;
                   ']' => ']'
 );
 
+$pi = 3.141592653589;
+$d2r = ($pi/180);
+$r2d = (180/$pi);
+
+
 # a full time for logging and other purposes
 sub atime
 {
@@ -200,7 +202,7 @@ sub parraypairs
        my $ref = shift;
        my $i;
        my $out;
-  
+
        for ($i = 0; $i < @$ref; $i += 2) {
                my $r1 = @$ref[$i];
                my $r2 = @$ref[$i+1];
@@ -211,6 +213,20 @@ sub parraypairs
        return $out;
 }
 
+# take the arg as a hash reference and print it out as such
+sub phash
+{
+       my $ref = shift;
+       my $out;
+
+       while (my ($k,$v) = each %$ref) {
+               $out .= "${k}=>$v, ";
+       }
+       chop $out;                                      # remove last space
+       chop $out;                                      # remove last comma
+       return $out;
+}
+
 sub _sort_fields
 {
        my $ref = shift;
@@ -366,18 +382,20 @@ sub unpad
 # check that a field only has callsign characters in it
 sub is_callsign
 {
-       return $_[0] =~ m!^(?:[A-Z]{1,2}\d+ | \d[A-Z]{1,2}\d+)        # basic prefix
-                       (?:/(?:[A-Z]{1,2}\d+ | \d[A-Z]{1,2}\d+))?  # / another one (possibly)
-                                          [A-Z]{1,3}                                 # callsign letters
-                                          (?:/(?:[A-Z]{1,2}\d+ | \d[A-Z]{1,2}\d+))?  # / another prefix possibly
-                       (?:/[0-9A-Z]{1,2})?                        # /0-9A-Z+ possibly
-                                          (?:-\d{1,2})?                              # - nn possibly
-                                        $!x;
+       return $_[0] =~ m!^
+                                         (?:\d?[A-Z]{1,2}\d*/)?    # out of area prefix /  
+                                         (?:\d?[A-Z]{1,2}\d+)      # main prefix one (required) 
+                                         [A-Z]{1,5}                # callsign letters (required)
+                                         (?:-(?:\d{1,2}|\#))?      # - nn possibly (eg G8BPQ-8) or -# (an RBN spot) 
+                                         (?:/[0-9A-Z]{1,7})?       # / another prefix, callsign or special label (including /MM, /P as well as /EURO or /LGT) possibly
+                                         $!x;
+
+       # longest callign allowed is 1X11/1Y11XXXXX-11/XXXXXXX
 }
 
 sub is_prefix
 {
-       return $_[0] =~ m!^(?:[A-Z]{1,2}\d+ | \d[A-Z]{1,2}\d+)!x        # basic prefix
+       return $_[0] =~ m!^(?:[A-Z]{1,2}\d+ | \d[A-Z]{1,2}}\d+)!x        # basic prefix
 }
        
 
@@ -410,7 +428,8 @@ sub is_digits
 # does it look like a qra locator?
 sub is_qra
 {
-       return $_[0] =~ /^[A-Ra-r][A-Ra-r]\d\d[A-Xa-x][A-Xa-x]$/;
+       return unless length $_[0] == 4 || length $_[0] == 6;
+       return $_[0] =~ /^[A-Ra-r][A-Ra-r]\d\d(?:[A-Xa-x][A-Xa-x])?$/;
 }
 
 # does it look like a valid lat/long
@@ -419,6 +438,12 @@ sub is_latlong
        return $_[0] =~ /^\s*\d{1,2}\s+\d{1,2}\s*[NnSs]\s+1?\d{1,2}\s+\d{1,2}\s*[EeWw]\s*$/;
 }
 
+# is it an ip address?
+sub is_ipaddr
+{
+    return $_[0] =~ /^\d+\.\d+\.\d+\.\d+$/ || $_[0] =~ /^[0-9a-f:,]+$/;
+}
+
 # insert an item into a list if it isn't already there returns 1 if there 0 if not
 sub insertitem
 {
@@ -440,3 +465,54 @@ sub deleteitem
        @$list = grep {$_ ne $item } @$list;
        return $n - @$list;
 }
+
+# find the correct local_data directory
+# basically, if there is a local_data directory with this filename and it is younger than the
+# equivalent one in the (system) data directory then return that name rather than the system one
+sub localdata
+{
+       my $ifn = shift;
+       my $ofn = "$main::data/$ifn";
+       my $tfn;
+       
+       if (-e "$main::local_data") {
+               $tfn = "$main::local_data/$ifn";
+               if (-e $tfn && -e $ofn) {
+                       $ofn = $tfn if -M $tfn < -M $ofn;
+               } elsif (-e $tfn) {
+                       $ofn = $tfn;
+               }
+       }
+
+       return $ofn;
+}
+
+# move a file or a directory from data -> local_data if isn't there already
+sub localdata_mv
+{
+       my $ifn = shift;
+       if (-e "$main::data/$ifn" ) {
+               unless (-e "$main::local_data/$ifn") {
+                       move("$main::data/$ifn", "$main::local_data/$ifn") or die "localdata_mv: cannot move $ifn from '$main::data' -> '$main::local_data' $!\n";
+               }
+       }
+}
+
+# measure the time taken for something to happen; use Time::HiRes qw(gettimeofday tv_interval);
+sub diffms
+{
+       my $call = shift;
+       my $line = shift;
+       my $ta = shift;
+       my $no = shift;
+       my $tb = shift || [gettimeofday];
+
+       my $a = int($ta->[0] * 1000) + int($ta->[1] / 1000); 
+       my $b = int($tb->[0] * 1000) + int($tb->[1] / 1000);
+       my $msecs = $b - $a;
+
+       $line =~ s|\s+$||;
+       my $s = "subprocess stats cmd: '$line' $call ${msecs}mS";
+       $s .= " $no lines" if $no;
+       DXDebug::dbg($s);
+}