diff options
| -rw-r--r-- | MANIFEST | 1 | ||||
| -rw-r--r-- | Makefile.PL | 2 | ||||
| -rwxr-xr-x | beam | 49 | ||||
| -rw-r--r-- | beam.conf | 150 | ||||
| -rw-r--r-- | lib/App/Beam.pm | 280 | ||||
| -rw-r--r-- | lib/App/Beam/Backup.pm | 18 | ||||
| -rw-r--r-- | lib/App/Beam/Config.pm | 38 |
7 files changed, 415 insertions, 123 deletions
@@ -4,6 +4,7 @@ MANIFEST Makefile.PL README lib/App/Beam/Config.pm +lib/App/Beam.pm t/TestConfig.pm t/conf01.t t/conf02.t diff --git a/Makefile.PL b/Makefile.PL index 80f5548..0d99cd8 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -7,7 +7,7 @@ WriteMakefile(NAME => 'App::Beam', AUTHOR => 'Sergey Poznyakoff <gray@gnu.org>', LICENSE => 'gpl_3', ABSTRACT => 'Backup tool', -# EXE_FILES => [ 'beam' ], + EXE_FILES => [ 'beam' ], MIN_PERL_VERSION => 5.006, META_MERGE => { 'meta-spec' => { version => 2 }, @@ -0,0 +1,49 @@ +#!/usr/bin/perl + +use strict; +use App::Beam::Backup; +use Pod::Usage; +use Pod::Man; +use File::Basename; +use Getopt::Long qw(:config gnu_getopt no_ignore_case require_order); +use Unix::Sysexits; +use Data::Dumper; + +my $progname = basename($0); +my $progdescr = 'backup manager'; +my %args; + +GetOptions("h" => sub { + pod2usage(-message => "$progname: $progdescr", + -exitstatus => EX_OK); + }, + "help" => sub { + pod2usage(-exitstatus => EX_OK, -verbose => 2); + }, + "usage" => sub { + pod2usage(-exitstatus => EX_OK, -verbose => 0); + }, + "debug|d" => sub { $args{debug}++ }, + "dry-run|n" => sub { $args{dry_run} = 1 }, + "config-file|f=s" => sub { $args{config} = $_[1] } +) or exit(EX_USAGE); + +unless (@ARGV) { + print STDERR "$progname: no command name\n"; + exit(EX_USAGE); +} + +my %ctab = ( + backup => sub { + return new App::Beam::Backup(@_); + } +); + +unless (defined($ctab{$ARGV[0]})) { + print STDERR "$progname: no such command\n"; + exit(EX_USAGE); +} +my $beam = $ctab{$ARGV[0]}(%args); +$beam->begin; +$beam->run(@ARGV); +$beam->end; @@ -1,114 +1,44 @@ -########################################################################## -# Hooks -########################################################################## -# -# Special variables, called hooks, allow you to supply arbitrary -# procedures to be run before and after backup. -# When set, a hook must contain a whitespace-separated list of commands to -# be invoked. These commands will be invoked without arguments and in -# order of their appearance in the list. - -# Commands listed in openlog_hook are run before opening the logfile. The -# most common use for this hook is to rotate an oversized logfile prior to -# opening it. -[hook openlog] - command = beam_logrotate - -# The prologue_hook is a list of commands to run before starting backup -# (or restore). -[hook prologue] - command = -# The epilogue_hook is a list of commands to run when the backup -# (or restore) finishes. -[hook epilogue] - command = - -[core] - # Interval in weeks during which old backups and snapshots are - # retained. - # If zero or empty, backups are retained forever. - retain-interval = +[core] + # Location of the state file + statfile = /var/spool/beam/beam.state # Directory for temporary files tempdir = /tmp - # Set to On, if you wish backup procedures to be verbose. - verbose = On - # List of items to backup - items = dbdump system - -[tar] - # Thes variables configure invocation of tar. - - # Any additional options to pass to tar. Do not place tar operation - # switches (as -c, -t, etc.) here! These will be added automatically - # by appropriate scripts, depending on the operation being performed. - # - # By default this variable is empty (no additional options). - # - options = -j - - # Suffix for archive files. - # Default is "tar" - # - suffix = tar.bz2 - - # Directory where archive files are to be located. It's OK to specify - # a remote directory here, e.g. 10.10.0.1:/export/backup - # - # This variable must be set. Whatever directory it points to must - # already exist, the backup script won't create it. - archive-dir = /var/backups - - # Directory where to store snapshot files. The files will be named as - # their archive counterparts, with the suffix ".db". - # - # This variable must be set - snapshot-dir = /var/lib/backups - -[item dbdump] - type = postgres - database = mydb - -[item system] - type = fs - directory = / - files = etc var/spool - -[report] - # Comma-separated list of emails to send backup reports to. If emply, - # mail notifications are not sent. - email = - - # Sender email address. Backup reports will appear to be sent from - # this address. The default value is root@$(hostname). - # If set, this variable must contain a single email address, without - # personal part or comments, e.g. - sender = - - # You can supply personal part of the sender email using this variable. - # The personal part will be enclosed in double quotes and prepended to - # the value of $backup_sender_email to form a valid RFC-2822 "From" - # header. - # For example, if you have: - # sender = root@example.com - # sender-personal = Automatic backup report - # you will see the following in the report headers: - # From: "Automatic backup report" <root@example.com> - sender-personal = - - # Supply additional header for the report message. By default, - # the following headers are generated: - # From, To, Subject, X-Beam-Items, X-Beam-Round and X-Beam-Level. - # The three X- headers contain the backed up items (as set in the - # backup_items variable), backup round and backup level numbers, - # correspondingly. - # - # Multiple headers statements are OK - header = X-My-Info: ok - - # Any text to be output before the actual report. - intro = - - # Text to be added at the end of the report. - signature = +# Configure logging +[logger] + # Declare the channel. Valid values are: "file" and "syslog" + channel = file + # Debug verbosity level + debug = 0 + +# This section is inspected if logger.channel=syslog +[logger syslog] + # Syslog facility to use + facility = user + # Syslog tag (default - base name of the program) + tag = beam + # Syslog options (a comma-separated list). Valid options are: + # ndelay, noeol, nofatal, nonul, nowait, perror, and pid. + options = pid + +# This section is inspected if logger.channel=file +[logger file] + # Name of the log file. Unless set, STDERR is used. + #name = /var/log/backup.log + + # Append to the file, if it exists + append = On + # Print timestamp. Valid values (case-insensitive): + # on, yes, true, t, 1 - to enable + # off, no, false, f, nil, 0 - to disable + timestamp = On + +# Configures backup schedule +[schedule] + # Do this number of incremental backups in each round + levels = 2 + # Do this number of rounds before starting next full backup + rounds = 3 + # Retain this number of completed rounds. + retain = 8 diff --git a/lib/App/Beam.pm b/lib/App/Beam.pm new file mode 100644 index 0000000..82d8f97 --- /dev/null +++ b/lib/App/Beam.pm @@ -0,0 +1,280 @@ +package App::Beam; + +use strict; +use Carp; +use File::Basename; +use Sys::Syslog; +use Unix::Sysexits; +use Fcntl qw(:flock SEEK_SET); +use Storable qw(fd_retrieve nstore_fd); +use POSIX qw(strftime); + +require App::Beam::Config; +our @ISA = qw(App::Beam::Config); + +my $default_config_file = '/etc/beam.conf'; + +sub ck_bool { + my ($vref) = @_; + my %bool = ( '1' => 1, + 'yes' => 1, + 'on' => 1, + 'true' => 1, + 't' => 1, + '0' => 0, + 'no' => 0, + 'off' => 0, + 'false' => 0, + 'f' => 0, + 'nil' => 0 ); + return "not a valid boolean" + unless exists $bool{lc $$vref}; + $$vref = $bool{lc $$vref}; + return undef; +} + +sub ck_number { + my ($vref) = @_; + return "not a number" + unless $$vref =~ /^\d+/; + return undef; +} + +my %parameters = ( + logger => { + section => { + channel => { + check => sub { + my ($vref) = @_; + return "unknown channel" + unless grep { $_ eq $$vref } qw(syslog file); + return undef; + }, + default => 'file' + }, + debug => { check => \&ck_number }, + syslog => { + section => { + facility => { + check => sub { + my $vref = shift; + my @faclist = qw (auth authpriv cron daemon + ftp kern + local0 local1 local2 local3 + local4 local5 local6 local7 + lpr mail news syslog user uucp); + return "unknown syslog facility" + unless (grep { $$vref eq $_ } @faclist); + return undef; + }, + default => 'user' + }, + tag => 1, + options => { default => 'pid' } + } + }, + file => { + section => { + timestamp => { check => \&ck_bool }, + name => 1, + append => { check => \&ck_bool, default => 1 }, + } + } + } + }, + schedule => { + section => { + levels => { check => \&ck_number, default => 2 }, + rounds => { check => \&ck_number, default => 3 }, + retain => { check => \&ck_number, default => 8 }, + }, + }, + core => { + section => { + statfile => { default => '/var/spool/beam/beam.state' }, + tempdir => { default => '/tmp' }, + } + } +); + +sub new { + my $class = shift; + local %_ = @_; + my $filename; + my $progname; + my $v; + my $dry_run; + + if (defined($v = delete $_{progname})) { + $progname = $v; + } else { + $progname = basename($0); + } + + if (defined($v = delete $_{config})) { + $filename = $v; + } else { + $filename = $default_config_file; + } + + $dry_run = delete $_{dry_run}; + + $_{parameters} = \%parameters; +# $_{debug} = sub { print "D @_\n"; }; + + my $self = $class->SUPER::new($filename, %_); + + $self->{progname} = $progname; + $self->{dry_run} = $dry_run; + + return $self; +} + +sub get { + my $self = shift; + return $self->SUPER::get(map { split /\./ } @_); +} + +sub isset { + my $self = shift; + return $self->SUPER::isset(map { split /\./ } @_); +} + +sub issection { + my $self = shift; + return $self->SUPER::issection(map { split /\./ } @_); +} + +sub isscalar { + my $self = shift; + return $self->SUPER::isscalar(map { split /\./ } @_); +} + +sub set { + my $self = shift; + return $self->SUPER::set(map { split /\./ } @_); +} + +sub unset { + my $self = shift; + return $self->SUPER::unset(map { split /\./ } @_); +} + +sub logfmt { + my $self = shift; + my $prio = shift; + my $fmt = shift; + $self->logger($prio, sprintf($fmt, @_)); +} + +sub logger { + my $self = shift; + my $prio = shift; + my $msg = join(' ', map { my $a = $_; $a =~ s/\n/\\n/g; $a } @_); + + if ($self->get('logger.channel') eq 'syslog') { + syslog($prio, $msg); + } else { + print STDERR strftime '%b %d %H:%M:%S ', localtime + if $self->get('logger.file.timestamp'); + print STDERR "$self->{progname}: $prio: $msg\n"; + } +} + +sub error { + my ($self, $err) = @_; + $self->logger('err', $err); +} + +sub abend { + my $self = shift; + my $code = shift; + $self->logger('crit', @_); + exit($code); +} + +# Locks the statfile and retrieves data from it into {status} +sub lock { + my $self = shift; + my $file = $self->get('core.statfile'); + unless (open($self->{statfd}, '+>>', $file)) { + $self->abend(EX_CANTCREAT, "can't open file $file: $!"); + } + unless (flock($self->{statfd}, LOCK_EX | LOCK_NB)) { + $self->abend(EX_TEMPFAIL, "can't lock file $file: $!"); + } + seek($self->{statfd}, 0, SEEK_SET); + if ((stat($self->{statfd}))[7] == 0) { + $self->{status} = { round => 0, + level => 0, + timestamp => time() }; + } else { + $self->{status} = fd_retrieve($self->{statfd}) + or $self->abend(EX_UNAVAILABLE, "can't retrieve status from $file: $!"); + } +} + +# Saves the current status and unlocks the status file. +sub unlock { + my ($self) = @_; + croak "unlock without lock" unless defined $self->{statfd}; + if ($self->{status}{updated}) { + delete $self->{status}{updated}; + seek($self->{statfd}, 0, SEEK_SET); + truncate($self->{statfd}, 0); + nstore_fd($self->{status}, $self->{statfd}); + } + flock($self->{statfd}, LOCK_UN); + close($self->{statfd}); +} + +sub status { + my ($self,$name,$val) = @_; + my $ret = $self->{status}{$name} if exists $self->{status}{$name}; + if (defined($val)) { +# print "SET $name=$val\n"; + $self->{status}{$name} = $val; + $self->{status}{updated} = 1 unless $self->{dry_run}; + } + return $ret; +} + +sub begin { + my $self = shift; + exit(EX_CONFIG) unless $self->parse(); + if ($self->get('logger.channel') eq 'syslog') { + my $facility = $self->get('logger.syslog.facility') || 'user'; + my $tag = $self->get('logger.syslog.tag') || $self->{progname}; + my $options = $self->get('logger.syslog.options') || 'pid'; + openlog($tag, $options, $facility) + or do { + croak "openlog failed"; + exit(EX_CONFIG); + } + } elsif (my $filename = $self->get('logger.file.name')) { + my $mode = $self->get('logger.file.append') ? '>>' : '>'; + open(STDERR, $mode, $filename) + or do { + croak "can't open file $filename for logging"; + exit(EX_CANTCREAT); + }; + } + if (!exists($self->{debug}) && defined(my $v = $self->get('logger.debug'))) { + $self->{debug} = $v; + } + $self->logger('info', 'startup'); +} + +sub end { + my $self = shift; + $self->logger('info', 'shutdown'); + if ($self->get('logger.channel') eq 'syslog') { + closelog(); + } +} + +sub run { + my $self = shift; + $self->abend(EX_SOFTWARE, "unsupported command $_[0]"); +} + diff --git a/lib/App/Beam/Backup.pm b/lib/App/Beam/Backup.pm new file mode 100644 index 0000000..d6c30a5 --- /dev/null +++ b/lib/App/Beam/Backup.pm @@ -0,0 +1,18 @@ +package App::Beam::Backup; + +use strict; +use Carp; + +require App::Beam; +our @ISA = qw(App::Beam); + +sub run { + my $self = shift; + $self->lock(); + use Data::Dumper; + print Dumper([$self->{status}]); + $self->status('round', $self->status('round') + 1); + $self->status('timestamp', time()); + $self->unlock(); +# print Dumper([$self->{conf}]); +} diff --git a/lib/App/Beam/Config.pm b/lib/App/Beam/Config.pm index d86b258..46624bb 100644 --- a/lib/App/Beam/Config.pm +++ b/lib/App/Beam/Config.pm @@ -32,6 +32,13 @@ sub error { print STDERR "$err\n"; } +sub debug { + my $self = shift; + my $lev = shift; + return unless $self->{debug} >= $lev; + $self->logger('debug', "config:", @_); +} + sub new { my $class = shift; my $filename = shift; @@ -41,12 +48,7 @@ sub new { my $err; if (defined($v = delete $_{debug})) { - if (ref($v) eq 'CODE') { - $self->{debug} = $v; - } else { - carp "debug must refer to a CODE"; - ++$err; - } + $self->{debug} = $v; } if (defined($v = delete $_{ci})) { @@ -101,8 +103,7 @@ sub writecache { return unless exists $self->{cachefile}; return unless exists $self->{conf}; return unless $self->{updated}; - &{$self->{debug}}("storing cache file $self->{cachefile}") - if exists $self->{debug}; + $self->debug(1, "storing cache file $self->{cachefile}"); store $self->{conf}, $self->{cachefile}; } @@ -190,7 +191,7 @@ sub readconfig { my $conf = shift; local %_ = @_; - &{$self->{debug}}("reading file $file") if exists $self->{debug}; + $self->debug(1, "reading file $file"); open(my $fd, "<", $file) or do { $self->error("can't open configuration file $file: $!"); @@ -301,6 +302,19 @@ sub readconfig { return $err; } +sub fixup { + my $self = shift; + my $params = shift; + while (my ($kv, $descr) = each %$params) { + next unless ref($descr) eq 'HASH'; + if (exists($descr->{section})) { + $self->fixup($descr->{section}, @_, $kv); + } elsif (exists($descr->{default}) && !$self->isset(@_, $kv)) { + $self->set(@_, $kv, $descr->{default}); + } + } +} + sub file_up_to_date { my ($self, $file) = @_; my $st_conf = stat($self->{filename}) or return 1; @@ -316,8 +330,7 @@ sub parse { if (exists($self->{cachefile}) and -f $self->{cachefile}) { if ($self->file_up_to_date($self->{cachefile})) { my $ref; - &{$self->{debug}}("reading from cache file $self->{cachefile}") - if exists $self->{debug}; + $self->debug(1, "reading from cache file $self->{cachefile}"); eval { $ref = retrieve($self->{cachefile}); }; if (defined($ref)) { $self->{conf} = $ref; @@ -330,11 +343,12 @@ sub parse { unlink $self->{cachefile}; } - &{$self->{debug}}("parsing $self->{filename}") if exists $self->{debug}; + $self->debug(1, "parsing $self->{filename}"); my $err = $self->readconfig($self->{filename}, \%conf); if ($err == 0) { $self->{conf} = \%conf ; $self->{updated} = 1; + $self->fixup($self->{parameters}) if exists $self->{parameters}; } return !$err; } |