+# turn a hex field into printed hex
+sub phex
+{
+ my $val = shift;
+ 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 ref $ref ? join(', ', @{$ref}) : $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;
+}
+
+# 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;
+ my @a = split /,/, $ref->field_prompt(shift);
+ my @b = split /,/, $ref->field_prompt(shift);
+ return lc $a[1] cmp lc $b[1];
+}
+
+# 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;
+ my $width = $self->width - 1;
+ $width ||= 80;
+
+ foreach $field (sort {_sort_fields($ref, $a, $b)} @fields) {
+ if (defined $ref->{$field}) {
+ my ($priv, $ans) = promptf($ref->field_prompt($field), $ref->{$field});
+ my @tmp;
+ if (length $ans > $width) {
+ my ($p, $a) = split /: /, $ans, 2;
+ my $l = (length $p) + 2;
+ my $al = ($width - 1) - $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;
+ }
+}
+
+sub filecopy
+{
+ copy(@_) or return $!;
+}
+
+# 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] =~ 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 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 */-)
+sub is_pcflag
+{
+ return $_[0] =~ /^[01\*\-]+$/;
+}
+
+# check that a thing is a frequency
+sub is_freq
+{
+ return $_[0] =~ /^\d+(?:\.\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-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+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
+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;
+}