File Coverage

blib/lib/Apache/HealthCheck.pm

Criterion	Covered	Total	%
statement	4	6	66.6
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	6	8	75.0

package Apache::HealthCheck;

use 5.006001;
use Apache::Constants qw(:common);
use LWP::UserAgent;
use HTTP::Request;
use strict;
use warnings;

our @ISA = qw();

our $VERSION = '0.01';

sub handler {
    my ($r) = @_;

    my @check_urls = $r->dir_config->get('CheckURL');
    my $hn_success = $r->dir_config('HeaderNameSuccess');
    my $hn_fail = $r->dir_config('HeaderNameFail');
    my $hv_success = $r->dir_config('HeaderValueSuccess');
    my $hv_fail = $r->dir_config('HeaderValueFail');
    my $rc_success = $r->dir_config('ReturnCodeSuccess');
    my $rc_fail = $r->dir_config('ReturnCodeFail');
    my $html_success = $r->dir_config('HTMLSuccess');
    my $html_fail = $r->dir_config('HTMLFail');
    my $track_in_hdr = lc($r->dir_config('TrackResultsInHeader')) eq "on" ? 1 : 0;
    my $timeout = $r->dir_config('CheckTimeout') ? $r->dir_config('CheckTimeout') : 10;
    my $check_ua = $r->dir_config('CheckUserAgent') ? $r->dir_config('CheckUserAgent') : "Mozilla/5.0 (compatible; Apache::HealthCheck $VERSION;)";
    my $check_method = $r->dir_config('CheckMethod') ? $r->dir_config('CheckMethod') : "HEAD";

    my $ua = LWP::UserAgent->new(
        timeout     =>      $timeout,
        agent       =>      $check_ua,
    );

    my $tests = scalar(@check_urls);
    my $passed;

    my $i = 0;
    foreach my $url (@check_urls) {
        my ($result) = check_url($url, $ua, $check_method);
        ++$i;
        $passed += $result;
        if ($track_in_hdr) {
            if ($result) {
                $r->header_out("X-HealthCheck-$i-Success"       =>      $url);
            } else {
                $r->header_out("X-HealthCheck-$i-Fail"          =>      $url);
            }
        }
    }

    $r->content_type('text/html');

    if ($track_in_hdr) {
        $r->header_out("X-HealthCheck-Results"           =>      "$passed of $tests tests passed!");
    }

    if ($passed == $tests) {
        # all passed!
        $rc_success = $rc_success ? $rc_success : OK;
        $html_success = $html_success ? $html_success : "SUCCESS";
        send_result($r, $hn_success, $hv_success, $rc_success, $html_success);
    } else {
        # not all passed!
        $rc_fail = $rc_fail ? $rc_fail : SERVER_ERROR;
        $html_fail = $html_fail ? $html_fail : "FAIL";
        send_result($r, $hn_fail, $hv_fail, $rc_fail, $html_fail);
    }
    return OK;
}

sub send_result {
    my ($r, $hn, $hv, $rc, $html) = @_;

    if ($hn && $hv) {
        $r->header_out($hn      =>      $hv);
    }
    $r->status($rc);

    # print the header
    $r->send_http_header;

    if (-e $html) {
        open(HTML, '<', $html);
        {
            local $/;
            print ;
        }
        close(HTML);
    } else {
        print "$html";
    }
}

sub check_url {
    my ($in_url, $ua, $method) = @_;
    my ($url, $valid_rc_string) = split(/\s+/, $in_url);
    my (@valid_rc) = split(/\s*,\s*/, $valid_rc_string);
    my $req = HTTP::Request->new(uc($method), $url);
    my $resp = $ua->simple_request($req);

    if ($resp) {
        # check if it's a valid return code..
        return is_valid_rc($resp->code, @valid_rc);
    } else {
        # if nothing came back, return undef!
        return undef;
    }
}

sub is_valid_rc {
    my ($rc, @vrcs) = @_;
    foreach my $vrc (@vrcs) {
        if ($rc == $vrc) {
            return 1;
        }
    }
    return undef;
}

# Preloaded methods go here.

1;
__END__