mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2024-12-14 10:13:05 +02:00
de7fc37f88
Refactor storage layer to allow for new repository filesystems using drivers. (Reviewed by Cynthia Shang.) Refactor IO layer to allow for new compression formats, checksum types, and other capabilities using filters. (Reviewed by Cynthia Shang.)
127 lines
4.6 KiB
Perl
127 lines
4.6 KiB
Perl
####################################################################################################################################
|
|
# Base IO/Filter Module
|
|
####################################################################################################################################
|
|
package pgBackRest::Common::Io::Base;
|
|
|
|
use strict;
|
|
use warnings FATAL => qw(all);
|
|
use Carp qw(confess);
|
|
use English '-no_match_vars';
|
|
|
|
use Exporter qw(import);
|
|
our @EXPORT = qw();
|
|
use Scalar::Util qw(blessed);
|
|
|
|
use pgBackRest::Common::Log;
|
|
|
|
####################################################################################################################################
|
|
# Package name constant
|
|
####################################################################################################################################
|
|
use constant COMMON_IO_BASE => __PACKAGE__;
|
|
push @EXPORT, qw(COMMON_IO_BASE);
|
|
|
|
####################################################################################################################################
|
|
# Default buffer max
|
|
####################################################################################################################################
|
|
use constant COMMON_IO_BUFFER_MAX => 4194304;
|
|
push @EXPORT, qw(COMMON_IO_BUFFER_MAX);
|
|
|
|
####################################################################################################################################
|
|
# new
|
|
####################################################################################################################################
|
|
sub new
|
|
{
|
|
my $class = shift;
|
|
|
|
# Create the class hash
|
|
my $self = {};
|
|
bless $self, $class;
|
|
|
|
# Assign function parameters, defaults, and log debug info
|
|
(
|
|
my $strOperation,
|
|
$self->{strId},
|
|
) =
|
|
logDebugParam
|
|
(
|
|
__PACKAGE__ . '->new', \@_,
|
|
{name => 'strId', trace => true},
|
|
);
|
|
|
|
# Initialize the ISA stack
|
|
$self->{stryIsA} = [COMMON_IO_BASE];
|
|
|
|
# Return from function and log return values if any
|
|
return logDebugReturn
|
|
(
|
|
$strOperation,
|
|
{name => 'self', value => $self}
|
|
);
|
|
}
|
|
|
|
####################################################################################################################################
|
|
# error - throw errors
|
|
####################################################################################################################################
|
|
sub error
|
|
{
|
|
my $self = shift;
|
|
my $iCode = shift;
|
|
my $strMessage = shift;
|
|
my $strDetail = shift;
|
|
|
|
logErrorResult($iCode, $strMessage, $strDetail);
|
|
}
|
|
|
|
####################################################################################################################################
|
|
# isA - get the list of parent classes and add the current class
|
|
####################################################################################################################################
|
|
sub isA
|
|
{
|
|
my $self = shift;
|
|
|
|
unshift(@{$self->{stryIsA}}, $self->className());
|
|
|
|
return @{$self->{stryIsA}};
|
|
}
|
|
|
|
####################################################################################################################################
|
|
# result - retrieve a result from io or a filter
|
|
####################################################################################################################################
|
|
sub result
|
|
{
|
|
my $self = shift;
|
|
my $strModule = shift;
|
|
|
|
if (!defined($strModule))
|
|
{
|
|
return $self->{rhResult};
|
|
}
|
|
|
|
return $self->{rhResult}{$strModule};
|
|
}
|
|
|
|
####################################################################################################################################
|
|
# resultSet - set a result from io or a filter
|
|
####################################################################################################################################
|
|
sub resultSet
|
|
{
|
|
my $self = shift;
|
|
my $strModule = shift;
|
|
my $xResult = shift;
|
|
|
|
$self->{rhResult}{$strModule} = $xResult;
|
|
}
|
|
|
|
####################################################################################################################################
|
|
# DESTROY - call close()
|
|
####################################################################################################################################
|
|
sub DESTROY {shift->close()}
|
|
|
|
####################################################################################################################################
|
|
# Getters
|
|
####################################################################################################################################
|
|
sub className {blessed(shift)}
|
|
sub id {shift->{strId}}
|
|
|
|
1;
|