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 October 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 Statistics::Descriptive;

sub action
{
    # Init
    my($str, $strNone, $strGood, $frequency, $header);

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

    # Start loop
    foreach my $host ( GetUserHosts(1) ) {
        my($incrCnt, $incrAge, $reasonHilite,
           $lastAge, $lastAgeColor, $tempState, $tempReason, $lastXferErrors, $lastXferErrorsColor);
        my($shortErr);
        my $bpc = BackupPC::Lib->new();
        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) );

        # Get frequency for this host
        if ( $Conf{IncrPeriod} < $Conf{FullPeriod} ) {
            $frequency = $Conf{IncrPeriod};
        } else {
          $frequency = $Conf{FullPeriod};
        }

        # Age
        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};
                }
            } elsif ( $Backups[$i]{type} eq "incr" ) {
                $incrCnt++;
                if ( $incrAge < 0 || $Backups[$i]{startTime} > $incrAge ) {
                    $incrAge = $Backups[$i]{startTime};
                }
            }
        }
        if ( $fullAge > $incrAge && $fullAge >= 0 )  {
            $lastAge = $fullAge;
        } else {
            $lastAge = $incrAge;
        }
        if ( $lastAge < 0 ) {
            $lastAge = 0;
        } else {
            $lastAge = sprintf("%.1f", (time - $lastAge) / (24 * 3600));
        }

        # Color for age
        if ( $lastAge < $frequency ) {
            $lastAgeColor = "MediumSeaGreen";
        } else {
          $lastAgeColor = "Tomato";
        }
        if ( $fullAge < 0 ) {
            $fullAge = 0;
        } else {
            $fullAge = sprintf("%.1f", (time - $fullAge) / (24 * 3600));
        }
        if ( $incrAge < 0 ) {
            $incrAge = 0;
        } else {
            $incrAge = sprintf("%.1f", (time - $incrAge) / (24 * 3600));
        }
        $incrAge = "&nbsp;" if ( $incrAge eq "" );
        # Color for errors
        $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 Backup is disable
      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)";
      }

      # Check Size Consistency
      my $mainConf = $bpc->ConfigDataRead();
      my $check = {};

      my $hostConf = $bpc->ConfigDataRead($host);
      my $conf = { %$mainConf, %$hostConf };
      my $age = -1;
      $check = {
        new_size        => 0,
        new_size_avg    => 0,
        new_size_median => 0,
        new_size_q1     => 0,
        new_size_q3     => 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$/ );
          # 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 );
        }

        # 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;

        $check->{new_size}         = $bpc_info[$i]->{sizeNew};
        $check->{new_size_avg}     = int $sizes->mean;
        $check->{new_size_median}  = int $sizes->median;
        $check->{new_size_q1}      = eval { int $sizes->quantile(1) } || 0;
        $check->{new_size_q3}      = eval { int $sizes->quantile(3) } || 0;
      }

      # TOO BIG ?
      my $toobig = "1";
      if ( $check->{new_size} > ($check->{new_size_q3} + $check->{new_size_q3} - $check->{new_size_q1}) * 1.5 or $check->{new_size} > $check->{new_size_avg} * 6 ) {
        $toobig = "1";
        }
      else {
        $toobig = "0";
      }

      # TOO SMALL ?
      my $toosmall = "1";
      if ( $check->{new_size} < ($check->{new_size_q1} - $check->{new_size_q3} - $check->{new_size_q1}) * 1.5 or $check->{new_size} < $check->{new_size_avg} / 3 ) {
        $toosmall = "1";
        }
      else {
        $toosmall = "0";
      }

      my $sizeConsistency = "<strong>ANOMALOUS</strong>";
      my $sizeConsistencyColor = "Tomato";

      # Get result
      if ( $toobig or $toosmall ) {
        $sizeConsistency = "<strong>ANOMALOUS</strong>";
        $sizeConsistencyColor = "Tomato";
        }
      else {
        $sizeConsistency = "Normal";
        $sizeConsistencyColor = "MediumSeaGreen";
      }

      # Get URL for explore file
      my $browseFile = "?action=browse&host=$host";

      # Show summary
      $str = <<EOF;
      <tr$reasonHilite><td class="border">${HostLink($host)}</td>
      <td align="center" class="border" style="color:$lastAgeColor;">$lastAge <em>(Freq: $frequency)</em></td>
      <td align="center" class="border" style="color:$lastXferErrorsColor;">$lastXferErrors</td>
      <td align="center" class="border" style="color:$sizeConsistencyColor;">$sizeConsistency</td>
      <td align="center" class="border"><a href="$browseFile" target="_blank">Explore files ...</a></td>
EOF

      # Increment counter
      if ( @Backups == 0 ) {
          $strNone .= $str;
      } else {
          $strGood .= $str;
      }
    }
    # End loop

    # Time set
    my $now            = timeStamp2(time);
    my $DUmaxTime      = timeStamp2($Info{DUDailyMaxTime});
    my $DUInodemaxTime = timeStamp2($Info{DUInodeDailyMaxTime});

    # Show header
    $header = <<EOF;
    \${h1(qq{BackupPC: Check})}
    <p>This check was generated at <strong>\$now</strong>.</p>

    <p>File system pool size usage (\$DUmaxTime) :</p>
    <div style="background-color:#f1f1f1!important">
      <div style="color:#fff!important;background-color:#2196F3!important; text-align:center; width:\$Info{DUDailyMax}%">\$Info{DUDailyMax}%</div>
    </div>

    <p>File system inode size usage (\$DUInodemaxTime) :</p>
    <div style="background-color:#f1f1f1!important">
      <div style="color:#fff!important;background-color:#2196F3!important; text-align:center; width:\$Info{DUInodeDailyMax}%">\$Info{DUInodeDailyMax}%</div>
    </div>

    \${h2("Backups summary")}

    <table class="sortable" id="host_summary_backups" border cellpadding="3" cellspacing="1">
    <tr class="tableheader"><td> Host </td>
        <td> Last backup in days </td>
        <td> Errors </td>
        <td> Size Consistency </td>
        <td> Browse </td>
    \$strGood
    </table>
EOF

    # Show page
    my $content = eval ("qq{$header}");
    Header("BackupPC: Check", $content);
    Trailer();
}

1;