/usr/lib/amanda/perl/Amanda/Curinfo.pm is in amanda-common 1:3.3.6-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 | # Copyright (c) 2010-2013 Zmanda, Inc. All Rights Reserved.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
# for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# Contact information: Zmanda Inc., 465 S. Mathilda Ave., Suite 300
# Sunnyvale, CA 94085, USA, or: http://www.zmanda.com
package Amanda::Curinfo;
use strict;
use warnings;
use Carp;
use File::Copy;
use File::Path qw( mkpath );
use Amanda::Debug qw( :logging );
use Amanda::Util qw( sanitise_filename );
use Amanda::Curinfo::Info;
=head1 NAME
Amanda::Curinfo - Perl extension for representing the curinfo database
=head1 SYNOPSIS
use Amanda::Curinfo;
use Amanda::Curinfo::Info;
...
my $ci = Amanda::Curinfo->new($somedir);
my $info = $ci->get_info($host, $disk);
...
$ci->put_info($host, $disk, $newinfo);
...
$ci->del_info($oldhost, $olddisk);
=head1 DESCRIPTION
C<Amanda::Curinfo> is a pure perl implementation of the older infofile
libraries.
This package manages a directory of files, referred to in the code as
an C<$infodir>, that contain dump data. Each of these files is stored
in a nested directory structure by its host and disk name. These
files can be accessed and modified using the provided functions with
the help of the L<Amanda::Curinfo::Info> class.
Note that this terminology is slightly different from the older
infofile.h implementation. Users with no experience with infofile.h
can skip to the interface section.
In the API for infofile.h, the term C<infofile> actually refers a
directory. This directory is called an C<infodir> within the
infofile.c code. This directory held text files, which are referred
to as both C<infofile> and C<txinfofile> internally to infofile.c.
This rewrite simplifies the terminology by referring to the storage
directory as an C<$infodir> and an individual data-storing file as a
C<$infofile>.
=head1 INTERFACE
C<Amanda::Curinfo> is an interface to retrieve and store info files
regarding the backup history of DLEs.
C<Amanda::Curinfo> provides three major routines for handling info
file data.
The C<Amanda::Curinfo> constructor is pretty straightforward:
my $ci = Amanda::Curinfo->new($infodir);
Where C<$infodir> is a directory. In order to retrieve a previously
stored info file if the host and disk are known, one can use
my $info = $ci->get_info($host, $disk);
Once the structure has been updated, it may be re-written to the
database in a similar fashion:
$ci->put_info($host, $disk, $info);
If one would like to erase an existing info entry in an infodir, the
usage is the same as retrieving an info object.
$ci->del_info($host, $disk);
To create a new info object, please see the documentation for
L<Amanda::Curinfo::Info>.
=head1 SEE ALSO
This module is meant to replicate the behavior of the library
described in server-src/infofile.h. If anyone notices any major
problems, please report them.
=head1 AUTHOR
Paul C. Mantz E<lt>pcmantz@zmanda.comE<gt>
=cut
sub new
{
my ($class, $infodir) = @_;
(defined $infodir)
|| croak("error: infodir not provided to Amanda::Curinfo");
my $self = { infodir => $infodir };
bless $self, $class;
return $self;
}
sub get_info
{
my ($self, $host, $disk) = @_;
my $infodir = $self->{infodir};
my $host_q = sanitise_filename($host);
my $disk_q = sanitise_filename($disk);
my $infofile = "$infodir/$host_q/$disk_q/info";
return Amanda::Curinfo::Info->new($infofile);
}
sub put_info
{
my ($self, $host, $disk, $info) = @_;
my $infodir = $self->{infodir};
my $host_q = sanitise_filename($host);
my $disk_q = sanitise_filename($disk);
my $infofiledir = "$infodir/$host_q/$disk_q";
my $infofile = "$infofiledir/info";
my $infofile_tmp = "$infofile.tmp";
if (-e $infofile) {
copy($infofile, $infofile_tmp)
|| croak "error: couldn't back up $infofile";
} elsif (!-d $infofiledir) {
mkpath($infofiledir)
|| croak "error: couldn't make path $infofiledir";
}
my $restore = sub {
if (-e $infofile_tmp) {
copy($infofile_tmp, $infofile)
|| croak
"error: couldn't restore infofile from backup $infofile_tmp";
unlink $infofile_tmp;
}
croak "error encountered when writing info to $infofile";
};
$info->write_to_file($infofile) || $restore->();
unlink $infofile_tmp if -e $infofile_tmp;
return 1;
}
sub del_info
{
my ($self, $host, $disk) = @_;
my $infodir = $self->{infodir};
my $host_q = sanitise_filename($host);
my $disk_q = sanitise_filename($disk);
my $infofile = "$infodir/$host_q/$disk_q/info";
return unlink $infofile;
}
1;
|