/usr/local/CPAN/Brackup/Brackup/Util.pm

• package Brackup::Util
  • _get_temp_directory
  • tempfile
  • tempfile_obj
  • tempdir
  • slurp
  • valid_params
  • noclobber_filename
  • io_print_to_fh
  • io_sha1
• EOF

package Brackup::Util;
use strict;
use warnings;
require Exporter;

use vars qw(@ISA @EXPORT_OK);
@ISA = ('Exporter');
@EXPORT_OK = qw(tempfile tempfile_obj tempdir slurp valid_params noclobber_filename io_print_to_fh io_sha1);

use File::Path qw();
use Carp;
use Fcntl qw(O_RDONLY);
use Digest::SHA1;

my $mainpid = $$;
my $_temp_directory;

END {
    # will happen after File::Temp's cleanup
    if ($$ == $mainpid and $_temp_directory) {
        File::Path::rmtree($_temp_directory, 0, 1) unless $ENV{BRACKUP_TEST_NOCLEANUP};
    }
}
use File::Temp ();

sub _get_temp_directory {
    # Create temporary directory if we need one. By default, all temporary
    # files will be placed in it.
    unless (defined($_temp_directory)) {
        $_temp_directory = File::Temp::tempdir(CLEANUP => $ENV{BRACKUP_TEST_NOCLEANUP} ? 0 : 1);
    }

    return $_temp_directory;
}

sub tempfile {
    my (@ret) = File::Temp::tempfile(DIR => _get_temp_directory());
    return wantarray ? @ret : $ret[0];
}

sub tempfile_obj {
    return File::Temp->new(DIR => _get_temp_directory(), CLEANUP => $ENV{BRACKUP_TEST_NOCLEANUP} ? 0 : 1);
}

# Utils::tempdir() accepts the same options as File::Temp::tempdir.
sub tempdir {
    my %options = @_;
    $options{DIR} ||= _get_temp_directory();
    return File::Temp::tempdir(%options);
}

sub slurp {
    my $file = shift;
    my %opts = @_;
    my $fh;
    if ($opts{decompress} and eval { require IO::Uncompress::AnyUncompress }) {
        $fh = IO::Uncompress::AnyUncompress->new($file)
            or die "Failed to open file $file: $IO::Uncompress::AnyUncompress::AnyUncompressError";
    } else {
        sysopen($fh, $file, O_RDONLY) or die "Failed to open $file: $!";
    }
    return do { local $/; <$fh>; };
}

sub valid_params {
    my ($vlist, %uarg) = @_;
    my %ret;
    $ret{$_} = delete $uarg{$_} foreach @$vlist;
    croak("Bogus options: " . join(', ', sort keys %uarg)) if %uarg;
    return %ret;
}

# Uniquify the given filename to avoid clobbering existing files
sub noclobber_filename {
    my ($filename) = @_;
    return $filename if ! -e $filename;
    for (my $i = 1; ; $i++) {
        return "$filename.$i" if ! -e "$filename.$i";
    }
}

# Prints all data from an IO::Handle to a filehandle
sub io_print_to_fh {
    my ($io_handle, $fh, $sha1) = @_;
    my $buf;
    my $bytes = 0;

    while($io_handle->read($buf, 4096)) {
        print $fh $buf;
        $bytes += length $buf;
        $sha1->add($buf) if $sha1;
    }

    return $bytes;
}

# computes sha1 of data in an IO::Handle
sub io_sha1 {
    my ($io_handle) = @_;
    
    my $sha1 = Digest::SHA1->new;
    my $buf;
    
    while($io_handle->read($buf, 4096)) {
        $sha1->add($buf);
    }

    return $sha1->hexdigest;
}

1;

# vim:sw=4