1. Sort out PC41 handling to include type 5 records for QRA locators and also
[spider.git] / perl / DXUtil.pm
index 81bace8ca1271ebc45021e3175cb80edc940592a..56e36d4220ba05bc43a6bd3195c4efa672a19b81 100644 (file)
@@ -9,15 +9,24 @@
 package DXUtil;
 
 use Date::Parse;
-use Carp;
+use IO::File;
+use Data::Dumper;
 
 require Exporter;
 @ISA = qw(Exporter);
-@EXPORT = qw(atime ztime cldate cldatetime slat slong yesno promptf parray parraypairs
-             print_all_fields cltounix 
+@EXPORT = qw(atime ztime cldate cldatetime slat slong yesno promptf 
+                        parray parraypairs phex shellregex readfilestr writefilestr
+             print_all_fields cltounix unpad is_callsign is_latlong
+                        is_qra is_freq is_digits is_pctext is_pcflag insertitem deleteitem
             );
 
 @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
+%patmap = (
+                  '*' => '.*',
+                  '?' => '.',
+                  '[' => '[',
+                  ']' => ']'
+);
 
 # a full time for logging and other purposes
 sub atime
@@ -33,20 +42,22 @@ sub atime
 sub ztime
 {
        my $t = shift;
-       my ($sec,$min,$hour) = gmtime((defined $t) ? $t : time);
-       $year += 1900;
-       my $buf = sprintf "%02d%02dZ", $hour, $min;
+       $t = defined $t ? $t : time;
+       my $dst = shift;
+       my ($sec,$min,$hour) = $dst ? localtime($t): gmtime($t);
+       my $buf = sprintf "%02d%02d%s", $hour, $min, ($dst) ? '' : 'Z';
        return $buf;
-
 }
 
 # get a cluster format date (23-Jun-1998)
 sub cldate
 {
        my $t = shift;
-       my ($sec,$min,$hour,$mday,$mon,$year) = gmtime((defined $t) ? $t : time);
+       $t = defined $t ? $t : time;
+       my $dst = shift;
+       my ($sec,$min,$hour,$mday,$mon,$year) = $dst ? localtime($t) : gmtime($t);
        $year += 1900;
-       my $buf = sprintf "%02d-%s-%04d", $mday, $month[$mon], $year;
+       my $buf = sprintf "%2d-%s-%04d", $mday, $month[$mon], $year;
        return $buf;
 }
 
@@ -54,8 +65,9 @@ sub cldate
 sub cldatetime
 {
        my $t = shift;
-       my $date = cldate($t);
-       my $time = ztime($t);
+       my $dst = shift;
+       my $date = cldate($t, $dst);
+       my $time = ztime($t, $dst);
        return "$date $time";
 }
 
@@ -64,9 +76,17 @@ sub cltounix
 {
        my $date = shift;
        my $time = shift;
-       $date =~ s/^\s*(\d+)-(\w\w\w)-(19\d\d)$/$1 $2 $3/;
-       $time =~ s/^(\d\d)(\d\d)Z$/$1:$2 +0000/;
-       return str2time("$date $time");
+       my ($thisyear) = (gmtime)[5] + 1900;
+
+       return 0 unless $date =~ /^\s*(\d+)-(\w\w\w)-([12][90]\d\d)$/;
+       return 0 if $3 > 2036;
+       return 0 unless abs($thisyear-$3) <= 1;
+       $date = "$1 $2 $3";
+       return 0 unless $time =~ /^([012]\d)([012345]\d)Z$/;
+       $time = "$1:$2 +0000";
+       my $r = str2time("$date $time");
+       return $r unless $r;
+       return $r == -1 ? undef : $r;
 }
 
 # turn a latitude in degrees into a string
@@ -110,11 +130,24 @@ sub promptf
        if ($action) {
                my $q = qq{\$value = $action(\$value)};
                eval $q;
+       } elsif (ref $value) {
+               my $dd = new Data::Dumper([$value]);
+               $dd->Indent(0);
+               $dd->Terse(1);
+               $dd->Quotekeys(0);
+               $value = $dd->Dumpxs;
        }
        $prompt = sprintf "%15s: %s", $prompt, $value;
        return ($priv, $prompt);
 }
 
+# turn a hex field into printed hex
+sub phex
+{
+       my $val = shift;
+       return sprintf '%X', $val;
+}
+
 # take an arg as an array list and print it
 sub parray
 {
@@ -148,18 +181,194 @@ sub print_all_fields
 {
        my $self = shift;                       # is a dxchan
        my $ref = shift;                        # is a thingy with field_prompt and fields methods defined
-       my @out = @_;
+       my @out;
        my @fields = $ref->fields;
        my $field;
-       my @out;
 
-       foreach $field (sort @fields) {
+       foreach $field (sort {$ref->field_prompt($a) cmp $ref->field_prompt($b)} @fields) {
                if (defined $ref->{$field}) {
                        my ($priv, $ans) = promptf($ref->field_prompt($field), $ref->{$field});
-                       push @out, $ans if ($self->priv >= $priv);
+                       my @tmp;
+                       if (length $ans > 79) {
+                               my ($p, $a) = split /: /, $ans, 2;
+                               my $l = (length $p) + 2;
+                               my $al = 79 - $l;
+                               my $bit;
+                               while (length $a > $al ) {
+                                       ($bit, $a) = unpack "A$al A*", $a;
+                                       push @tmp, "$p: $bit";
+                                       $p = ' ' x ($l - 2);
+                               }
+                               push @tmp, "$p: $a" if length $a;
+                       } else {
+                               push @tmp, $ans;
+                       }
+                       push @out, @tmp if ($self->priv >= $priv);
                }
        }
        return @out;
 }
 
+# generate a regex from a shell type expression 
+# see 'perl cookbook' 6.9
+sub shellregex
+{
+       my $in = shift;
+       $in =~ s{(.)} { $patmap{$1} || "\Q$1" }ge;
+       return '^' . $in . "\$";
+}
+
+# read in a file into a string and return it. 
+# the filename can be split into a dir and file and the 
+# file can be in upper or lower case.
+# there can also be a suffix
+sub readfilestr
+{
+       my ($dir, $file, $suffix) = @_;
+       my $fn;
+       my $f;
+       if ($suffix) {
+               $f = uc $file;
+               $fn = "$dir/$f.$suffix";
+               unless (-e $fn) {
+                       $f = lc $file;
+                       $fn = "$dir/$file.$suffix";
+               }
+       } elsif ($file) {
+               $f = uc $file;
+               $fn = "$dir/$file";
+               unless (-e $fn) {
+                       $f = lc $file;
+                       $fn = "$dir/$file";
+               }
+       } else {
+               $fn = $dir;
+       }
+
+       my $fh = new IO::File $fn;
+       my $s = undef;
+       if ($fh) {
+               local $/ = undef;
+               $s = <$fh>;
+               $fh->close;
+       }
+       return $s;
+}
+
+# write out a file in the format required for reading
+# in via readfilestr, it expects the same arguments 
+# and a reference to an object
+sub writefilestr
+{
+       my $dir = shift;
+       my $file = shift;
+       my $suffix = shift;
+       my $obj = shift;
+       my $fn;
+       my $f;
+       
+       confess('no object to write in writefilestr') unless $obj;
+       confess('object not a reference in writefilestr') unless ref $obj;
+       
+       if ($suffix) {
+               $f = uc $file;
+               $fn = "$dir/$f.$suffix";
+               unless (-e $fn) {
+                       $f = lc $file;
+                       $fn = "$dir/$file.$suffix";
+               }
+       } elsif ($file) {
+               $f = uc $file;
+               $fn = "$dir/$file";
+               unless (-e $fn) {
+                       $f = lc $file;
+                       $fn = "$dir/$file";
+               }
+       } else {
+               $fn = $dir;
+       }
+
+       my $fh = new IO::File ">$fn";
+       if ($fh) {
+               my $dd = new Data::Dumper([ $obj ]);
+               $dd->Indent(1);
+               $dd->Terse(1);
+               $dd->Quotekeys(0);
+               #       $fh->print(@_) if @_ > 0;     # any header comments, lines etc
+               $fh->print($dd->Dumpxs);
+               $fh->close;
+       }
+}
+
+# remove leading and trailing spaces from an input string
+sub unpad
+{
+       my $s = shift;
+       $s =~ s/\s+$//;
+       $s =~ s/^\s+//;
+       return $s;
+}
+
+# check that a field only has callsign characters in it
+sub is_callsign
+{
+       return $_[0] =~ /^(?:[A-Z]{1,2}\d+|\d[A-Z]\d+)[A-Z]+(?:-\d{1,2}|\/[A-Z0-9]+)?$/;
+}
+
+# check that a PC protocol field is valid text
+sub is_pctext
+{
+       return $_[0] =~ /^[\x09\x20-\xFF]+$/;
+}
+
+# check that a PC prot flag is fairly valid (doesn't check the difference between 1/0 and */-)
+sub is_pcflag
+{
+       return $_[0] =~ /^[01\*\-]+$/;
+}
+
+# check that a thing is a frequency
+sub is_freq
+{
+       return $_[0] =~ /^[\d\.]+$/;
+}
+
+# check that a thing is just digits
+sub is_digits
+{
+       return $_[0] =~ /^[\d]+$/;
+}
+
+# does it look like a qra locator?
+sub is_qra
+{
+       return $_[0] =~ /^[A-Za-z][A-Za-z]\d\d[A-Za-z][A-Za-z]$/o;
+}
+
+# does it look like a valid lat/long
+sub is_latlong
+{
+       return $_[0] =~ /^\s*\d{1,2}\s+\d{1,2}\s*[NnSs]\s+\d{1,2}\s+\d{1,2}\s*[EeWw]\s*$/;
+}
+
+# insert an item into a list if it isn't already there returns 1 if there 0 if not
+sub insertitem
+{
+       my $list = shift;
+       my $item = shift;
+       
+       return 1 if grep {$_ eq $item } @$list;
+       push @$list, $item;
+       return 0;
+}
+
+# delete an item from a list if it is there returns no deleted 
+sub deleteitem
+{
+       my $list = shift;
+       my $item = shift;
+       my $n = @$list;
+       
+       @$list = grep {$_ ne $item } @$list;
+       return $n - @$list;
+}