File Coverage

blib/lib/IPC/Cmd/Cached.pm

Criterion	Covered	Total	%
statement	44	56	78.5
branch	4	10	40.0
condition			n/a
subroutine	10	11	90.9
pod	0	5	0.0
total	58	82	70.7

###########################################
package IPC::Cmd::Cached;
###########################################
# 2007, Mike Schilli
###########################################

use strict;
use warnings;
use Cache::FileCache;
use IPC::Cmd;
use Storable qw(freeze thaw);
use Log::Log4perl qw(:easy);

our $VERSION = "0.01";

###########################################
sub new {
###########################################
    my($class, %options) = @_;

    my $self = {
        cache => undef,
        %options,
    };

    if(! defined $self->{cache}) {
        $self->{cache} = Cache::FileCache->new({
            auto_purge_on_get  => 1,
            default_expires_in => 24*3600,
            namespace          => "IPC-Cmd-Cached",
        });
    }

    bless $self, $class;
}

###########################################
sub run {
###########################################
    my($self, @opts) = @_;

    DEBUG "Running @opts";

    my @result = IPC::Cmd::run(@opts);

    if(! defined $result[0]) {
        ERROR $result[4]->[0];
        return undef;
    }

    DEBUG "Return: $result[0]\n";

    if($result[0]) {
        DEBUG "Stdout: ", join('', @{$result[3]});
    }

    my $data = freeze({
        result => \@result,
        opts   => \@opts,
        time   => time,
    });

    my $key = normalize(@opts);

    $self->{cache}->set($key, $data);

    return @result;
}

###########################################
sub run_cached {
###########################################
    my($self, @opts) = @_;

    my $key = normalize(@opts);

    my $stored = $self->{cache}->get($key);

    if(defined $stored) {
        DEBUG "Found result for @opts in cache";
        my $data = thaw($stored);
        return @{ $data->{result} };
    }

    DEBUG "Didn't find result for @opts in cache";
    return undef;
}

###########################################
sub normalize {
###########################################
    my(@args) = @_;

    return join(" ", @args);
}

###########################################
sub run_all {
###########################################
    my($self) = @_;

    for my $key ($self->{cache}->get_keys()) {
        my $stored = $self->{cache}->get( $key );

        if(defined $stored) {
            my $data = thaw($stored);
            $self->run( @{ $data->{opts} } );
        }
    }
}

1;

__END__