Fabio/ddclient
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

logging: Move filtering and reactions to Logger class

Browse source 
This increases overhead when the verbose or debug option is disabled,
but makes it possible for tests to intercept debug, info, and fatal
messages.
This commit is contained in:
Richard Hansen 2025-01-10 16:51:59 -05:00
parent b31e5e2f91
commit d18b1cdb27
1 changed files with 24 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
ddclient.in
View file

@ -2510,9 +2510,11 @@ sub ynu {
# provided (it is ignored if the `msg` keyword is present). # provided (it is ignored if the `msg` keyword is present).
sub log { sub log {
my $self = shift; my $self = shift;
my %args = (@_ % 2 ? (msg => pop) : (), @_); my %args = (label => '', @_ % 2 ? (msg => pop) : (), @_);
$args{ctx} = [$args{ctx} // ()] if ref($args{ctx}) eq ''; $args{ctx} = [$args{ctx} // ()] if ref($args{ctx}) eq '';
return $self->_log(\%args); $self->_log(\%args);
$self->_failed() if $args{label} eq 'FAILED';
$self->_abort() if $args{label} eq 'FATAL';
} }
sub _log { sub _log {
@ -2521,10 +2523,11 @@ sub ynu {
# the caller's arrayref (in case it is reused in a future call). # the caller's arrayref (in case it is reused in a future call).
$args->{ctx} = [@{$self->{ctx}}, @{$args->{ctx}}]; $args->{ctx} = [@{$self->{ctx}}, @{$args->{ctx}}];
return $self->{parent}->_log($args) if defined($self->{parent}); return $self->{parent}->_log($args) if defined($self->{parent});
return if $args->{label} eq 'DEBUG' && !ddclient::opt('debug');
return if $args->{label} eq 'INFO' && !ddclient::opt('verbose');
my $buffer = $args->{msg} // ''; my $buffer = $args->{msg} // '';
chomp($buffer); chomp($buffer);
if (!$args->{raw}) { if (!$args->{raw}) {
$args->{label} //= '';
my $prefix = $args->{label} ne '' ? sprintf("%-8s ", $args->{label} . ':') : ''; my $prefix = $args->{label} ne '' ? sprintf("%-8s ", $args->{label} . ':') : '';
$prefix .= "[$_]" for @{$args->{ctx}}; $prefix .= "[$_]" for @{$args->{ctx}};
$prefix .= '> ' if $prefix; $prefix .= '> ' if $prefix;
@ -2544,6 +2547,20 @@ sub ynu {
} }
} }
} }
sub _failed {
my ($self) = @_;
return $self->{parent}->_failed() if defined($self->{parent});
$ddclient::result = 'FAILED';
$ddclient::result if 0; # Suppress spurious "used only once: possible typo" warning.
}
sub _abort {
my ($self) = @_;
return $self->{parent}->_abort() if defined($self->{parent});
ddclient::sendmail();
exit(1);
}
} }
# Intended use: # Intended use:
@ -2552,12 +2569,12 @@ sub pushlogctx { my ($ctx) = @_; return ddclient::Logger->new($ctx, $_l); }
sub logmsg { $_l->log(@_); } sub logmsg { $_l->log(@_); }
sub _logmsg_fmt { $_[0] eq 'ctx' ? (shift, shift) : (), (@_ > 1) ? sprintf(shift, @_) : shift; } sub _logmsg_fmt { $_[0] eq 'ctx' ? (shift, shift) : (), (@_ > 1) ? sprintf(shift, @_) : shift; }
sub info { logmsg(email => 1, label => 'INFO', _logmsg_fmt(@_)) if opt('verbose'); } sub info { logmsg(email => 1, label => 'INFO', _logmsg_fmt(@_)); }
sub debug { logmsg( label => 'DEBUG', _logmsg_fmt(@_)) if opt('debug'); } sub debug { logmsg( label => 'DEBUG', _logmsg_fmt(@_)); }
sub warning { logmsg(email => 1, label => 'WARNING', _logmsg_fmt(@_)); } sub warning { logmsg(email => 1, label => 'WARNING', _logmsg_fmt(@_)); }
sub fatal { logmsg(email => 1, label => 'FATAL', _logmsg_fmt(@_)); sendmail(); exit(1); } sub fatal { logmsg(email => 1, label => 'FATAL', _logmsg_fmt(@_)); }
sub success { logmsg(email => 1, label => 'SUCCESS', _logmsg_fmt(@_)); } sub success { logmsg(email => 1, label => 'SUCCESS', _logmsg_fmt(@_)); }
sub failed { logmsg(email => 1, label => 'FAILED', _logmsg_fmt(@_)); $result = 'FAILED'; } sub failed { logmsg(email => 1, label => 'FAILED', _logmsg_fmt(@_)); }
sub prettytime { return scalar(localtime(shift)); } sub prettytime { return scalar(localtime(shift)); }