perl/DXUtil.pm

   1 #
   2 # various utilities which are exported globally
   3 #
   4 # Copyright (c) 1998 - Dirk Koopman G1TLH
   5 #
   6 # $Id$
   7 #
   8
   9 package DXUtil;
  10
  11 use Date::Parse;
  12 use IO::File;
  13 use File::Copy;
  14 use Data::Dumper;
  15
  16 use strict;
  17
  18 use vars qw($VERSION $BRANCH);
  19 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
  20 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/  || (0,0));
  21 $main::build += $VERSION;
  22 $main::branch += $BRANCH;
  23
  24 use vars qw(@month %patmap @ISA @EXPORT);
  25
  26 require Exporter;
  27 @ISA = qw(Exporter);
  28 @EXPORT = qw(atime ztime cldate cldatetime slat slong yesno promptf
  29                          parray parraypairs phex shellregex readfilestr writefilestr
  30                          filecopy ptimelist
  31              print_all_fields cltounix unpad is_callsign is_latlong
  32                          is_qra is_freq is_digits is_pctext is_pcflag insertitem deleteitem
  33                          is_prefix dd
  34             );
  35
  36
  37 @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
  38 %patmap = (
  39                    '*' => '.*',
  40                    '?' => '.',
  41                    '[' => '[',
  42                    ']' => ']'
  43 );
  44
  45 # a full time for logging and other purposes
  46 sub atime
  47 {
  48         my $t = shift;
  49         my ($sec,$min,$hour,$mday,$mon,$year) = gmtime((defined $t) ? $t : time);
  50         $year += 1900;
  51         my $buf = sprintf "%02d%s%04d\@%02d:%02d:%02d", $mday, $month[$mon], $year, $hour, $min, $sec;
  52         return $buf;
  53 }
  54
  55 # get a zulu time in cluster format (2300Z)
  56 sub ztime
  57 {
  58         my $t = shift;
  59         $t = defined $t ? $t : time;
  60         my $dst = shift;
  61         my ($sec,$min,$hour) = $dst ? localtime($t): gmtime($t);
  62         my $buf = sprintf "%02d%02d%s", $hour, $min, ($dst) ? '' : 'Z';
  63         return $buf;
  64 }
  65
  66 # get a cluster format date (23-Jun-1998)
  67 sub cldate
  68 {
  69         my $t = shift;
  70         $t = defined $t ? $t : time;
  71         my $dst = shift;
  72         my ($sec,$min,$hour,$mday,$mon,$year) = $dst ? localtime($t) : gmtime($t);
  73         $year += 1900;
  74         my $buf = sprintf "%2d-%s-%04d", $mday, $month[$mon], $year;
  75         return $buf;
  76 }
  77
  78 # return a cluster style date time
  79 sub cldatetime
  80 {
  81         my $t = shift;
  82         my $dst = shift;
  83         my $date = cldate($t, $dst);
  84         my $time = ztime($t, $dst);
  85         return "$date $time";
  86 }
  87
  88 # return a unix date from a cluster date and time
  89 sub cltounix
  90 {
  91         my $date = shift;
  92         my $time = shift;
  93         my ($thisyear) = (gmtime)[5] + 1900;
  94
  95         return 0 unless $date =~ /^\s*(\d+)-(\w\w\w)-([12][90]\d\d)$/;
  96         return 0 if $3 > 2036;
  97         return 0 unless abs($thisyear-$3) <= 1;
  98         $date = "$1 $2 $3";
  99         return 0 unless $time =~ /^([012]\d)([012345]\d)Z$/;
 100         $time = "$1:$2 +0000";
 101         my $r = str2time("$date $time");
 102         return $r unless $r;
 103         return $r == -1 ? undef : $r;
 104 }
 105
 106 # turn a latitude in degrees into a string
 107 sub slat
 108 {
 109         my $n = shift;
 110         my ($deg, $min, $let);
 111         $let = $n >= 0 ? 'N' : 'S';
 112         $n = abs $n;
 113         $deg = int $n;
 114         $min = int ((($n - $deg) * 60) + 0.5);
 115         return "$deg $min $let";
 116 }
 117
 118 # turn a longitude in degrees into a string
 119 sub slong
 120 {
 121         my $n = shift;
 122         my ($deg, $min, $let);
 123         $let = $n >= 0 ? 'E' : 'W';
 124         $n = abs $n;
 125         $deg = int $n;
 126         $min = int ((($n - $deg) * 60) + 0.5);
 127         return "$deg $min $let";
 128 }
 129
 130 # turn a true into 'yes' and false into 'no'
 131 sub yesno
 132 {
 133         my $n = shift;
 134         return $n ? $main::yes : $main::no;
 135 }
 136
 137 # provide a data dumpered version of the object passed
 138 sub dd
 139 {
 140         my $value = shift;
 141         my $dd = new Data::Dumper([$value]);
 142         $dd->Indent(0);
 143         $dd->Terse(1);
 144     $dd->Quotekeys($] < 5.005 ? 1 : 0);
 145         $value = $dd->Dumpxs;
 146         $value =~ s/([\r\n\t])/sprintf("%%%02X", ord($1))/eg;
 147         $value =~ s/^\s*\[//;
 148     $value =~ s/\]\s*$//;
 149
 150         return $value;
 151 }
 152
 153 # format a prompt with its current value and return it with its privilege
 154 sub promptf
 155 {
 156         my ($line, $value) = @_;
 157         my ($priv, $prompt, $action) = split ',', $line;
 158
 159         # if there is an action treat it as a subroutine and replace $value
 160         if ($action) {
 161                 my $q = qq{\$value = $action(\$value)};
 162                 eval $q;
 163         } elsif (ref $value) {
 164                 $value = dd($value);
 165         }
 166         $prompt = sprintf "%15s: %s", $prompt, $value;
 167         return ($priv, $prompt);
 168 }
 169
 170 # turn a hex field into printed hex
 171 sub phex
 172 {
 173         my $val = shift;
 174         return sprintf '%X', $val;
 175 }
 176
 177 # take an arg as a hash of call=>time pairs and print it
 178 sub ptimelist
 179 {
 180         my $ref = shift;
 181         my $out;
 182         for (sort keys %$ref) {
 183                 $out .= "$_=$ref->{$_}, ";
 184         }
 185         chop $out;
 186         chop $out;
 187         return $out;
 188 }
 189
 190 # take an arg as an array list and print it
 191 sub parray
 192 {
 193         my $ref = shift;
 194         return ref $ref ? join(', ', @{$ref}) : $ref;
 195 }
 196
 197 # take the arg as an array reference and print as a list of pairs
 198 sub parraypairs
 199 {
 200         my $ref = shift;
 201         my $i;
 202         my $out;
 203
 204         for ($i = 0; $i < @$ref; $i += 2) {
 205                 my $r1 = @$ref[$i];
 206                 my $r2 = @$ref[$i+1];
 207                 $out .= "$r1-$r2, ";
 208         }
 209         chop $out;                                      # remove last space
 210         chop $out;                                      # remove last comma
 211         return $out;
 212 }
 213
 214 sub _sort_fields
 215 {
 216         my $ref = shift;
 217         my @a = split /,/, $ref->field_prompt(shift);
 218         my @b = split /,/, $ref->field_prompt(shift);
 219         return lc $a[1] cmp lc $b[1];
 220 }
 221
 222 # print all the fields for a record according to privilege
 223 #
 224 # The prompt record is of the format '<priv>,<prompt>[,<action>'
 225 # and is expanded by promptf above
 226 #
 227 sub print_all_fields
 228 {
 229         my $self = shift;                       # is a dxchan
 230         my $ref = shift;                        # is a thingy with field_prompt and fields methods defined
 231         my @out;
 232         my @fields = $ref->fields;
 233         my $field;
 234         my $width = $self->width - 1;
 235         $width ||= 80;
 236
 237         foreach $field (sort {_sort_fields($ref, $a, $b)} @fields) {
 238                 if (defined $ref->{$field}) {
 239                         my ($priv, $ans) = promptf($ref->field_prompt($field), $ref->{$field});
 240                         my @tmp;
 241                         if (length $ans > $width) {
 242                                 my ($p, $a) = split /: /, $ans, 2;
 243                                 my $l = (length $p) + 2;
 244                                 my $al = ($width - 1) - $l;
 245                                 my $bit;
 246                                 while (length $a > $al ) {
 247                                         ($bit, $a) = unpack "A$al A*", $a;
 248                                         push @tmp, "$p: $bit";
 249                                         $p = ' ' x ($l - 2);
 250                                 }
 251                                 push @tmp, "$p: $a" if length $a;
 252                         } else {
 253                                 push @tmp, $ans;
 254                         }
 255                         push @out, @tmp if ($self->priv >= $priv);
 256                 }
 257         }
 258         return @out;
 259 }
 260
 261 # generate a regex from a shell type expression
 262 # see 'perl cookbook' 6.9
 263 sub shellregex
 264 {
 265         my $in = shift;
 266         $in =~ s{(.)} { $patmap{$1} || "\Q$1" }ge;
 267         return '^' . $in . "\$";
 268 }
 269
 270 # read in a file into a string and return it.
 271 # the filename can be split into a dir and file and the
 272 # file can be in upper or lower case.
 273 # there can also be a suffix
 274 sub readfilestr
 275 {
 276         my ($dir, $file, $suffix) = @_;
 277         my $fn;
 278         my $f;
 279         if ($suffix) {
 280                 $f = uc $file;
 281                 $fn = "$dir/$f.$suffix";
 282                 unless (-e $fn) {
 283                         $f = lc $file;
 284                         $fn = "$dir/$file.$suffix";
 285                 }
 286         } elsif ($file) {
 287                 $f = uc $file;
 288                 $fn = "$dir/$file";
 289                 unless (-e $fn) {
 290                         $f = lc $file;
 291                         $fn = "$dir/$file";
 292                 }
 293         } else {
 294                 $fn = $dir;
 295         }
 296
 297         my $fh = new IO::File $fn;
 298         my $s = undef;
 299         if ($fh) {
 300                 local $/ = undef;
 301                 $s = <$fh>;
 302                 $fh->close;
 303         }
 304         return $s;
 305 }
 306
 307 # write out a file in the format required for reading
 308 # in via readfilestr, it expects the same arguments
 309 # and a reference to an object
 310 sub writefilestr
 311 {
 312         my $dir = shift;
 313         my $file = shift;
 314         my $suffix = shift;
 315         my $obj = shift;
 316         my $fn;
 317         my $f;
 318
 319         confess('no object to write in writefilestr') unless $obj;
 320         confess('object not a reference in writefilestr') unless ref $obj;
 321
 322         if ($suffix) {
 323                 $f = uc $file;
 324                 $fn = "$dir/$f.$suffix";
 325                 unless (-e $fn) {
 326                         $f = lc $file;
 327                         $fn = "$dir/$file.$suffix";
 328                 }
 329         } elsif ($file) {
 330                 $f = uc $file;
 331                 $fn = "$dir/$file";
 332                 unless (-e $fn) {
 333                         $f = lc $file;
 334                         $fn = "$dir/$file";
 335                 }
 336         } else {
 337                 $fn = $dir;
 338         }
 339
 340         my $fh = new IO::File ">$fn";
 341         if ($fh) {
 342                 my $dd = new Data::Dumper([ $obj ]);
 343                 $dd->Indent(1);
 344                 $dd->Terse(1);
 345                 $dd->Quotekeys(0);
 346                 #       $fh->print(@_) if @_ > 0;     # any header comments, lines etc
 347                 $fh->print($dd->Dumpxs);
 348                 $fh->close;
 349         }
 350 }
 351
 352 sub filecopy
 353 {
 354         copy(@_) or return $!;
 355 }
 356
 357 # remove leading and trailing spaces from an input string
 358 sub unpad
 359 {
 360         my $s = shift;
 361         $s =~ s/\s+$//;
 362         $s =~ s/^\s+//;
 363         return $s;
 364 }
 365
 366 # check that a field only has callsign characters in it
 367 sub is_callsign
 368 {
 369         return $_[0] =~ m!^(?:[A-Z]{1,2}\d+ | \d[A-Z]{1,2}\d+)        # basic prefix
 370                        (?:/(?:[A-Z]{1,2}\d+ | \d[A-Z]{1,2}\d+))?  # / another one (possibly)
 371                                            [A-Z]{1,3}                                 # callsign letters
 372                                            (?:/(?:[A-Z]{1,2}\d+ | \d[A-Z]{1,2}\d+))?  # / another prefix possibly
 373                        (?:/[0-9A-Z]{1,2})?                        # /0-9A-Z+ possibly
 374                                            (?:-\d{1,2})?                              # - nn possibly
 375                                          $!x;
 376 }
 377
 378 sub is_prefix
 379 {
 380         return $_[0] =~ m!^(?:[A-Z]{1,2}\d+ | \d[A-Z]{1,2}\d+)!x        # basic prefix
 381 }
 382
 383
 384 # check that a PC protocol field is valid text
 385 sub is_pctext
 386 {
 387         return undef unless length $_[0];
 388         return undef if $_[0] =~ /[\x00-\x08\x0a-\x1f\x80-\x9f]/;
 389         return 1;
 390 }
 391
 392 # check that a PC prot flag is fairly valid (doesn't check the difference between 1/0 and */-)
 393 sub is_pcflag
 394 {
 395         return $_[0] =~ /^[01\*\-]+$/;
 396 }
 397
 398 # check that a thing is a frequency
 399 sub is_freq
 400 {
 401         return $_[0] =~ /^\d+(?:\.\d+)?$/;
 402 }
 403
 404 # check that a thing is just digits
 405 sub is_digits
 406 {
 407         return $_[0] =~ /^[\d]+$/;
 408 }
 409
 410 # does it look like a qra locator?
 411 sub is_qra
 412 {
 413         return $_[0] =~ /^[A-Ra-r][A-Ra-r]\d\d[A-Xa-x][A-Xa-x]$/;
 414 }
 415
 416 # does it look like a valid lat/long
 417 sub is_latlong
 418 {
 419         return $_[0] =~ /^\s*\d{1,2}\s+\d{1,2}\s*[NnSs]\s+1?\d{1,2}\s+\d{1,2}\s*[EeWw]\s*$/;
 420 }
 421
 422 # insert an item into a list if it isn't already there returns 1 if there 0 if not
 423 sub insertitem
 424 {
 425         my $list = shift;
 426         my $item = shift;
 427
 428         return 1 if grep {$_ eq $item } @$list;
 429         push @$list, $item;
 430         return 0;
 431 }
 432
 433 # delete an item from a list if it is there returns no deleted
 434 sub deleteitem
 435 {
 436         my $list = shift;
 437         my $item = shift;
 438         my $n = @$list;
 439
 440         @$list = grep {$_ ne $item } @$list;
 441         return $n - @$list;
 442 }