BackupPC-Check/Check.pm

#============================================================= -*-perl-*-
#
# BackupPC::CGI::Check package
#
# DESCRIPTION
#
#   This module implements the Check action for the CGI interface.
#
# AUTHOR
#   Heuze Florent  <heuzef@firewall-services.com>
#
#========================================================================
#
# Released Sept 2019 - firewall-services.com
#
#========================================================================

package BackupPC::CGI::Check;

use strict;
use lib "/usr/share/BackupPC/lib";
use BackupPC::Lib;
use BackupPC::CGI::Lib qw(:all);
use POSIX;
use JSON;
use Getopt::Long;
use Statistics::Descriptive;
use Data::Dumper;

my $host = "localhost";
my $entity = "";
my $sizeConsistency = size_consistency();

sub action
{
    my($fullTot, $fullSizeTot, $incrTot, $incrSizeTot, $str,
       $strNone, $strGood, $hostCntGood, $hostCntNone);

    $hostCntGood = $hostCntNone = 0;
    GetStatusInfo("hosts info");
    my $Privileged = CheckPermission();

    foreach my $host ( GetUserHosts(1) ) {
        my($fullDur, $incrCnt, $incrAge, $fullSize, $fullRate, $reasonHilite,
           $lastAge, $lastAgeColor, $tempState, $tempReason, $lastXferErrors, $lastXferErrorsColor);
	my($shortErr);
        my @Backups = $bpc->BackupInfoRead($host);
        my $fullCnt = $incrCnt = 0;
        my $fullAge = $incrAge = $lastAge = -1;

        $bpc->ConfigRead($host);
        %Conf = $bpc->Conf();

        next if ( $Conf{XferMethod} eq "archive" );
        next if ( !$Privileged && !CheckPermission($host) );

        for ( my $i = 0 ; $i < @Backups ; $i++ ) {
            if ( $Backups[$i]{type} eq "full" ) {
                $fullCnt++;
                if ( $fullAge < 0 || $Backups[$i]{startTime} > $fullAge ) {
                    $fullAge  = $Backups[$i]{startTime};
                    $fullSize = $Backups[$i]{size} / (1024 * 1024);
                    $fullDur  = $Backups[$i]{endTime} - $Backups[$i]{startTime};
                }
                $fullSizeTot += $Backups[$i]{size} / (1024 * 1024);
            } elsif ( $Backups[$i]{type} eq "incr" ) {
                $incrCnt++;
                if ( $incrAge < 0 || $Backups[$i]{startTime} > $incrAge ) {
                    $incrAge = $Backups[$i]{startTime};
                }
                $incrSizeTot += $Backups[$i]{size} / (1024 * 1024);
            }
        }
        if ( $fullAge > $incrAge && $fullAge >= 0 )  {
            $lastAge = $fullAge;
        } else {
            $lastAge = $incrAge;
        }
        if ( $lastAge < 0 ) {
            $lastAge = "";
        } else {
            $lastAge = sprintf("%.1f", (time - $lastAge) / (24 * 3600));
        }
        if ( $lastAge < 1.1 ) {
            $lastAgeColor = "MediumSeaGreen";
        } else {
          $lastAgeColor = "Tomato";
        }
        if ( $fullAge < 0 ) {
            $fullAge = "";
            $fullRate = "";
        } else {
            $fullAge = sprintf("%.1f", (time - $fullAge) / (24 * 3600));
            $fullRate = sprintf("%.2f",
                                $fullSize / ($fullDur <= 0 ? 1 : $fullDur));
        }
        if ( $incrAge < 0 ) {
            $incrAge = "";
        } else {
            $incrAge = sprintf("%.1f", (time - $incrAge) / (24 * 3600));
        }
        $fullTot += $fullCnt;
        $incrTot += $incrCnt;
        $fullSize = sprintf("%.2f", $fullSize / 1024);
	$incrAge = "&nbsp;" if ( $incrAge eq "" );
        $lastXferErrors = $Backups[@Backups-1]{xferErrs} if ( @Backups );
        if ( $lastXferErrors == 0 ) {
            $lastXferErrorsColor = "MediumSeaGreen";
        } else {
          $lastAgeColor = "Tomato";
        }
	$reasonHilite = $Conf{CgiStatusHilightColor}{$Status{$host}{reason}}
		      || $Conf{CgiStatusHilightColor}{$Status{$host}{state}};
	if ( $Conf{BackupsDisable} == 1 ) {
            if ( $Status{$host}{state} ne "Status_backup_in_progress"
                    && $Status{$host}{state} ne "Status_restore_in_progress" ) {
                $reasonHilite = $Conf{CgiStatusHilightColor}{Disabled_OnlyManualBackups};
                $tempState = "Disabled_OnlyManualBackups";
                $tempReason = "";
            } else {
                $tempState = $Status{$host}{state};
                $tempReason = $Status{$host}{reason};
            }
	} elsif ($Conf{BackupsDisable} == 2 ) {
	    $reasonHilite = $Conf{CgiStatusHilightColor}{Disabled_AllBackupsDisabled};
	    $tempState = "Disabled_AllBackupsDisabled";
	    $tempReason = "";
	} else {
	    $tempState = $Status{$host}{state};
	    $tempReason = $Status{$host}{reason};
	}
	$reasonHilite = " bgcolor=\"$reasonHilite\"" if ( $reasonHilite ne "" );
        if ( $tempState ne "Status_backup_in_progress"
		&& $tempState ne "Status_restore_in_progress"
		&& $Conf{BackupsDisable} == 0
		&& $Status{$host}{error} ne "" ) {
	    ($shortErr = $Status{$host}{error}) =~ s/(.{48}).*/$1.../;
	    $shortErr = " ($shortErr)";
	}

        $str = <<EOF;
<tr$reasonHilite><td class="border">${HostLink($host)}</td>
    <td align="center" class="border" style="color:$lastAgeColor;">$lastAge</td>
    <td align="center" class="border" style="color:$lastXferErrorsColor;">$lastXferErrors</td>
    <td align="center" class="border">$sizeConsistency</td>
    <td align="center" class="border"><a href="#" target="_blank">random-file.txt</a></td>
EOF
        if ( @Backups == 0 ) {
            $hostCntNone++;
            $strNone .= $str;
        } else {
            $hostCntGood++;
            $strGood .= $str;
        }
    }
    $fullSizeTot = sprintf("%.2f", $fullSizeTot / 1024);
    $incrSizeTot = sprintf("%.2f", $incrSizeTot / 1024);
    my $now      = timeStamp2(time);
    my $DUlastTime     = timeStamp2($Info{DUlastValueTime});
    my $DUmaxTime      = timeStamp2($Info{DUDailyMaxTime});
    my $DUInodemaxTime = timeStamp2($Info{DUInodeDailyMaxTime});

    my $content = eval ("qq{$Lang->{BackupPC_Check}}");
    Header($Lang->{BackupPC__Server_Check}, $content);
    Trailer();
}

sub size_consistency
{
    my $bpc = BackupPC::Lib->new();
    my $mainConf = $bpc->ConfigDataRead();
    my $json = {};

    if ( $host ) {
      my $hostConf = $bpc->ConfigDataRead($host);
      my $conf = { %$mainConf, %$hostConf };
      my $age = -1;
      $json = {
        bkp             => 0,
        full_size       => 0,
        errors          => 0,
        new_size        => 0,
        new_size_avg    => 0,
        new_size_median => 0,
        new_size_q1     => 0,
        new_size_q3     => 0,
        duration        => 0,
        comp_ratio      => 0
      };

      my $lastXferErrors        = 0;
      my $maxErrors             = 0;
      my $new_size_of_last_full = 0;
      my @bpc_info              = $bpc->BackupInfoRead($host);
      my $sizes                 = new Statistics::Descriptive::Full;

      if ( scalar( @bpc_info ) ){
        foreach my $backup ( @bpc_info ) {
          # Skip partial or active backups
          next if ( $backup->{type} !~ m/^full|incr$/ );
          if ( $backup->{type} eq "full" ) {
            $json->{full_size} = $backup->{size};
            $new_size_of_last_full = $backup->{sizeNew};
          }
          # Push all the sizes in our data set to compute avg sizes
          # Exclude backup N°0 as it'll always have much more new data than normal backups
          $sizes->add_data($backup->{sizeNew}) unless ( $backup->{num} == 0 );
          $json->{bkp}++;
        }

        # Ignore the last backup if it's not full or incr (which means it's either partial or active)
        my $i = ( $bpc_info[-1]->{type} =~ m/^full|incr$/ ) ? -1 : -2;

        $json->{errors}      = $bpc_info[$i]->{xferErrs};
        $json->{new_size}    = $bpc_info[$i]->{sizeNew};
        $json->{duration}    = $bpc_info[$i]->{endTime} - $bpc_info[$i]->{startTime};
        $json->{type}        = $bpc_info[$i]->{type};
        $json->{comp_ratio}  = ( $bpc_info[$i]->{sizeNew} > 0 ) ?
            sprintf( "%.2f", 100 - ( $bpc_info[$i]->{sizeNewComp} * 100 / $bpc_info[$i]->{sizeNew} ) )
              :
            0;

        $json->{new_size_avg}    = int $sizes->mean;
        $json->{new_size_median} = int $sizes->median;
        # Some old versions of Statistics::Descriptive (eg, on el5) do not support quantile
        $json->{new_size_q1}     = eval { int $sizes->quantile(1) } || 0;
        $json->{new_size_q3}     = eval { int $sizes->quantile(3) } || 0;
        $json->{enabled}         = ( $conf->{BackupsDisable} > 0 ) ? 0 : 1;
        $json->{total_size}      = $sizes->sum + $json->{full_size} - 2 * $new_size_of_last_full;
        $json->{age}             = time - $bpc_info[$i]->{startTime};

        $json->{max_errors} = $conf->{MaxXferError} || 0;
      }
    } elsif ( $entity ) {

      $json = {
        perf  => 0,
        size  => 0,
        hosts => 0,
        bkp   => 0,
        ratio => 0
      };

      my $total_new  = 0;
      my $total_comp = 0;

      foreach my $host ( keys %{ $bpc->HostInfoRead } ) {
        next unless $host =~ m/^(vm_)?\Q$entity\E_.*/;
        my $full_size;

        $json->{hosts}++;

        my $hostConf = $bpc->ConfigDataRead($host);
        my $conf     = { %$mainConf, %$hostConf };
        my $freq     = ( $conf->{FullPeriod} > $conf->{IncrPeriod} ) ? $conf->{IncrPeriod} : $conf->{FullPeriod};
        my $duration = 0;
        my $bkp_num  = 0;
        my $new_size_of_last_full = 0;

        foreach my $backup ( $bpc->BackupInfoRead( $host ) ) {
          next if ( $backup->{type} !~ m/^full|incr$/ );

          # Save the total size of the last full backup
          if ( $backup->{type} eq 'full' ) {
            $full_size             = $backup->{size};
            $new_size_of_last_full = $backup->{sizeNew};
          }

          $json->{size} += $backup->{sizeNew};
          $total_new    += $backup->{sizeNew};
          $total_comp   += $backup->{sizeNewComp};
          $duration     += $backup->{endTime} - $backup->{startTime};
          $bkp_num++;
          $json->{bkp}++;
        }
        # Compute the average cost as the number of hours per day spent
        # to backup this host
        $json->{perf} += ( $bkp_num > 0 ) ? $duration / ( 3600 * $bkp_num * $freq ) : 0;

        # $json->{size} represent the total size used by this host.
        # But we want to substract the new size of the last full, as for this one we
        # do not count sizeNew but size. As we've already added sizeNew we need to substract it 2 times
        $json->{size} += $full_size - 2 * $new_size_of_last_full;
      }
      $json->{ratio} = ( $total_new > 0 ) ? 100 - ( $total_comp * 100 / $total_new ) : 0;

      # Round some values
      foreach my $key ( qw(ratio perf) ) {
        $json->{$key} = sprintf( "%.2f", $json->{$key} );
      }

    } else {
      print("Error : Wrong usage");
    }

    my $toosmall = "true";
    if ( $json->{new_size} > $json->{new_size_q3} + $json->{new_size_q3} - $json->{new_size_q1} * 1.5 && $json->{new_size} > $json->{new_size_avg} * 6 ) {
      $toosmall = "false";
      }
    else {
      $toosmall = "true";
    }
    # TOO BIG ?
    my $toobig = "true";
    if ( $json->{new_size} < $json->{new_size_q1} - $json->{new_size_q3} - $json->{new_size_q1} * 1.5 && $json->{new_size} < $json->{new_size_avg} / 3 ) {
      $toobig = "false";
      }
    else {
      $toobig = "true";
    }

    # Print result
    if ( $toosmall == "false" && $toobig == "false" ) {
      my $sizeConsistency = print("Normal");
      }
    else {
      my $sizeConsistency = print("ANOMALOUS");
    }

    chomp $sizeConsistency;
    return $sizeConsistency;
}

1;