improve DXQsl handling and fix crashes?
[spider.git] / perl / DXUtil.pm
index 9d475ed89c8f2f17713b3aabdc9aa6c79d93d4df..abb20a96a4ec3c184d118a363d07f67530307a2a 100644 (file)
@@ -3,31 +3,28 @@
 #
 # Copyright (c) 1998 - Dirk Koopman G1TLH
 #
-# $Id$
+#
 #
 
 package DXUtil;
 
 use Date::Parse;
 use IO::File;
+use File::Copy;
 use Data::Dumper;
 
 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;
-$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
-             print_all_fields cltounix unpad is_callsign is_latlong
+                        parray parraypairs phex phash shellregex readfilestr writefilestr
+                        filecopy ptimelist
+             print_all_fields cltounix unpad is_callsign is_long_callsign is_latlong
                         is_qra is_freq is_digits is_pctext is_pcflag insertitem deleteitem
+                        is_prefix dd is_ipaddr $pi $d2r $r2d
             );
 
 
@@ -39,6 +36,11 @@ require Exporter;
                   ']' => ']'
 );
 
+$pi = 3.141592653589;
+$d2r = ($pi/180);
+$r2d = (180/$pi);
+
+
 # a full time for logging and other purposes
 sub atime
 {
@@ -131,6 +133,22 @@ sub yesno
        return $n ? $main::yes : $main::no;
 }
 
+# provide a data dumpered version of the object passed
+sub dd
+{
+       my $value = shift;
+       my $dd = new Data::Dumper([$value]);
+       $dd->Indent(0);
+       $dd->Terse(1);
+    $dd->Quotekeys($] < 5.005 ? 1 : 0);
+       $value = $dd->Dumpxs;
+       $value =~ s/([\r\n\t])/sprintf("%%%02X", ord($1))/eg;
+       $value =~ s/^\s*\[//;
+    $value =~ s/\]\s*$//;
+       
+       return $value;
+}
+
 # format a prompt with its current value and return it with its privilege
 sub promptf
 {
@@ -142,11 +160,7 @@ sub promptf
                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;
+               $value = dd($value);
        }
        $prompt = sprintf "%15s: %s", $prompt, $value;
        return ($priv, $prompt);
@@ -159,11 +173,24 @@ sub phex
        return sprintf '%X', $val;
 }
 
+# take an arg as a hash of call=>time pairs and print it
+sub ptimelist
+{
+       my $ref = shift;
+       my $out;
+       for (sort keys %$ref) {
+               $out .= "$_=$ref->{$_}, ";
+       }
+       chop $out;
+       chop $out;
+       return $out;    
+}
+
 # take an arg as an array list and print it
 sub parray
 {
        my $ref = shift;
-       return join(', ', @{$ref});
+       return ref $ref ? join(', ', @{$ref}) : $ref;
 }
 
 # take the arg as an array reference and print as a list of pairs
@@ -172,7 +199,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];
@@ -183,6 +210,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;
@@ -321,6 +362,11 @@ sub writefilestr
        }
 }
 
+sub filecopy
+{
+       copy(@_) or return $!;
+}
+
 # remove leading and trailing spaces from an input string
 sub unpad
 {
@@ -333,13 +379,39 @@ sub unpad
 # 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]+)?$/;
+       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,4}                                 # 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;
+}
+
+# check that a field only has callsign characters in it but has more than the standard 3 callsign letters
+sub is_long_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,5}                                 # 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;
+}
+
+sub is_prefix
+{
+       return $_[0] =~ m!^(?:[A-Z]{1,2}\d+ | \d[A-Z]{1,2}\d+)!x        # basic prefix
 }
+       
 
 # check that a PC protocol field is valid text
 sub is_pctext
 {
-       return $_[0] =~ /^[\x09\x20-\xFF]+$/;
+       return undef unless length $_[0];
+       return undef if $_[0] =~ /[\x00-\x08\x0a-\x1f\x80-\x9f]/;
+       return 1;
 }
 
 # check that a PC prot flag is fairly valid (doesn't check the difference between 1/0 and */-)
@@ -363,13 +435,20 @@ sub is_digits
 # 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;
+       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
 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*$/;
+       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
@@ -393,3 +472,4 @@ sub deleteitem
        @$list = grep {$_ ne $item } @$list;
        return $n - @$list;
 }
+