fixed iscallsign!
[spider.git] / perl / DXUtil.pm
index 3ce684988537bbfa5632790d2afb929b38c6240e..c4abc15bef7021d76c2352f55278350f02b3e3c9 100644 (file)
 
 package DXUtil;
 
+use Date::Parse;
+use Carp;
+
 require Exporter;
 @ISA = qw(Exporter);
-@EXPORT = qw(atime ztime cldate
+@EXPORT = qw(atime ztime cldate cldatetime slat slong yesno promptf 
+                        parray parraypairs shellregex
+             print_all_fields cltounix iscallsign
             );
 
 @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
 {
-  my $t = shift;
-  my ($sec,$min,$hour,$mday,$mon,$year) = gmtime((defined $t) ? $t : time);
-  $year += 1900;
-  my $buf = sprintf "%02d%s%04d\@%02d:%02d:%02d", $mday, $month[$mon], $year, $hour, $min, $sec;
-  return $buf;
+       my $t = shift;
+       my ($sec,$min,$hour,$mday,$mon,$year) = gmtime((defined $t) ? $t : time);
+       $year += 1900;
+       my $buf = sprintf "%02d%s%04d\@%02d:%02d:%02d", $mday, $month[$mon], $year, $hour, $min, $sec;
+       return $buf;
 }
 
 # get a zulu time in cluster format (2300Z)
 sub ztime
 {
-  my $t = shift;
-  my ($sec,$min,$hour) = gmtime((defined $t) ? $t : time);
-  $year += 1900;
-  my $buf = sprintf "%02d%02dZ", $hour, $min;
-  return $buf;
+       my $t = shift;
+       my ($sec,$min,$hour) = gmtime((defined $t) ? $t : time);
+       $year += 1900;
+       my $buf = sprintf "%02d%02dZ", $hour, $min;
+       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);
-  $year += 1900;
-  my $buf = sprintf "%02d-%s-%04d", $mday, $month[$mon], $year;
-  return $buf;
+       my $t = shift;
+       my ($sec,$min,$hour,$mday,$mon,$year) = gmtime((defined $t) ? $t : time);
+       $year += 1900;
+       my $buf = sprintf "%2d-%s-%04d", $mday, $month[$mon], $year;
+       return $buf;
+}
+
+# return a cluster style date time
+sub cldatetime
+{
+       my $t = shift;
+       my $date = cldate($t);
+       my $time = ztime($t);
+       return "$date $time";
+}
+
+# return a unix date from a cluster date and time
+sub cltounix
+{
+       my $date = shift;
+       my $time = shift;
+       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
+sub slat
+{
+       my $n = shift;
+       my ($deg, $min, $let);
+       $let = $n >= 0 ? 'N' : 'S';
+       $n = abs $n;
+       $deg = int $n;
+       $min = int ((($n - $deg) * 60) + 0.5);
+       return "$deg $min $let";
+}
 
+# turn a longitude in degrees into a string
+sub slong
+{
+       my $n = shift;
+       my ($deg, $min, $let);
+       $let = $n >= 0 ? 'E' : 'W';
+       $n = abs $n;
+       $deg = int $n;
+       $min = int ((($n - $deg) * 60) + 0.5);
+       return "$deg $min $let";
+}
+
+# turn a true into 'yes' and false into 'no'
+sub yesno
+{
+       my $n = shift;
+       return $n ? $main::yes : $main::no;
+}
+
+# format a prompt with its current value and return it with its privilege
+sub promptf
+{
+       my ($line, $value) = @_;
+       my ($priv, $prompt, $action) = split ',', $line;
+
+       # if there is an action treat it as a subroutine and replace $value
+       if ($action) {
+               my $q = qq{\$value = $action(\$value)};
+               eval $q;
+       }
+       $prompt = sprintf "%15s: %s", $prompt, $value;
+       return ($priv, $prompt);
+}
+
+# take an arg as an array list and print it
+sub parray
+{
+       my $ref = shift;
+       return join(', ', @{$ref});
+}
+
+# take the arg as an array reference and print as a list of pairs
+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];
+               $out .= "$r1-$r2, ";
+       }
+       chop $out;                                      # remove last space
+       chop $out;                                      # remove last comma
+       return $out;
+}
+
+# print all the fields for a record according to privilege
+#
+# The prompt record is of the format '<priv>,<prompt>[,<action>'
+# and is expanded by promptf above
+#
+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 @fields = $ref->fields;
+       my $field;
+
+       foreach $field (sort @fields) {
+               if (defined $ref->{$field}) {
+                       my ($priv, $ans) = promptf($ref->field_prompt($field), $ref->{$field});
+                       push @out, $ans 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 . "\$";
+}
+
+# start an attempt at determining whether this string might be a callsign
+sub iscallsign
+{
+       my $call = shift;
+       return 1 if $call =~ /^\w+\d+/;
+       return 1 if $call =~ /^\d+\w+/;
+       return undef;
+}