force pings (and other PC frames) to go down a local connection if
[spider.git] / perl / DXUtil.pm
index 7a81ac23a847ff19a2ba7835427e90a2721f0d12..2c05372c0f31b2d198a8959900ef8e2827b44817 100644 (file)
@@ -9,13 +9,15 @@
 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 shellregex
-             print_all_fields cltounix iscallsign
+                        parray parraypairs shellregex readfilestr writefilestr
+             print_all_fields cltounix iscallsign unpad is_callsign
+                        is_freq is_digits is_pctext is_pcflag insertitem deleteitem
             );
 
 @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
@@ -40,18 +42,20 @@ 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 "%2d-%s-%04d", $mday, $month[$mon], $year;
        return $buf;
@@ -61,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";
 }
 
@@ -167,7 +172,7 @@ sub print_all_fields
        my @fields = $ref->fields;
        my $field;
 
-       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);
@@ -188,8 +193,151 @@ sub shellregex
 # start an attempt at determining whether this string might be a callsign
 sub iscallsign
 {
-       my $call = shift;
-       return 1 if $call =~ /^\w+\s+/;
-       return 1 if $call =~ /^\d+\w+/;
+       my $call = uc shift;
+       return 1 if $call =~ /^[A-Z]+\d+[A-Z]+/;
+       return 1 if $call =~ /^\d+[A-Z]\d+[A-Z]+/;
        return undef;
 }
+
+# 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-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]+$/;
+}
+
+# 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;
+}