Current File : //usr/share/perl5/Dpkg/ErrorHandling.pm
# 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, see <https://www.gnu.org/licenses/>.
=encoding utf8
=head1 NAME
Dpkg::ErrorHandling - handle error conditions
=head1 DESCRIPTION
This module provides functions to handle all reporting and error handling.
B<Note>: This is a private module, its API can change at any time.
=cut
package Dpkg::ErrorHandling 0.02;
use strict;
use warnings;
use feature qw(state);
our @EXPORT_OK = qw(
REPORT_PROGNAME
REPORT_COMMAND
REPORT_STATUS
REPORT_DEBUG
REPORT_INFO
REPORT_NOTICE
REPORT_WARN
REPORT_ERROR
report_pretty
report_color
report
);
our @EXPORT = qw(
report_options
debug
info
notice
warning
error
errormsg
syserr
printcmd
subprocerr
usageerr
);
use Exporter qw(import);
use Dpkg ();
use Dpkg::Gettext;
my $quiet_warnings = 0;
my $debug_level = 0;
my $info_fh = \*STDOUT;
sub setup_color
{
my $mode = $ENV{'DPKG_COLORS'} // 'auto';
my $use_color;
if ($mode eq 'auto') {
## no critic (InputOutput::ProhibitInteractiveTest)
$use_color = 1 if -t *STDOUT or -t *STDERR;
} elsif ($mode eq 'always') {
$use_color = 1;
} else {
$use_color = 0;
}
require Term::ANSIColor if $use_color;
}
use constant {
REPORT_PROGNAME => 1,
REPORT_COMMAND => 2,
REPORT_STATUS => 3,
REPORT_INFO => 4,
REPORT_NOTICE => 5,
REPORT_WARN => 6,
REPORT_ERROR => 7,
REPORT_DEBUG => 8,
};
my %report_mode = (
REPORT_PROGNAME() => {
color => 'bold',
},
REPORT_COMMAND() => {
color => 'bold magenta',
},
REPORT_STATUS() => {
color => 'clear',
# We do not translate this name because the untranslated output is
# part of the interface.
name => 'status',
},
REPORT_DEBUG() => {
color => 'clear',
# We do not translate this name because it is a developer interface
# and all debug messages are untranslated anyway.
name => 'debug',
},
REPORT_INFO() => {
color => 'green',
name => g_('info'),
},
REPORT_NOTICE() => {
color => 'yellow',
name => g_('notice'),
},
REPORT_WARN() => {
color => 'bold yellow',
name => g_('warning'),
},
REPORT_ERROR() => {
color => 'bold red',
name => g_('error'),
},
);
sub report_options
{
my (%options) = @_;
if (exists $options{quiet_warnings}) {
$quiet_warnings = $options{quiet_warnings};
}
if (exists $options{debug_level}) {
$debug_level = $options{debug_level};
}
if (exists $options{info_fh}) {
$info_fh = $options{info_fh};
}
}
sub report_name
{
my $type = shift;
return $report_mode{$type}{name} // '';
}
sub report_color
{
my $type = shift;
return $report_mode{$type}{color} // 'clear';
}
sub report_pretty
{
my ($msg, $color) = @_;
state $use_color = setup_color();
if ($use_color) {
return Term::ANSIColor::colored($msg, $color);
} else {
return $msg;
}
}
sub _progname_prefix
{
return report_pretty("$Dpkg::PROGNAME: ", report_color(REPORT_PROGNAME));
}
sub _typename_prefix
{
my $type = shift;
return report_pretty(report_name($type), report_color($type));
}
sub report(@)
{
my ($type, $msg, @args) = @_;
$msg = sprintf $msg, @args if @args;
my $progname = _progname_prefix();
my $typename = _typename_prefix($type);
return "$progname$typename: $msg\n";
}
sub debug
{
my ($level, @args) = @_;
print report(REPORT_DEBUG, @args) if $level <= $debug_level;
}
sub info($;@)
{
my @args = @_;
print { $info_fh } report(REPORT_INFO, @args) if not $quiet_warnings;
}
sub notice
{
my @args = @_;
warn report(REPORT_NOTICE, @args) if not $quiet_warnings;
}
sub warning($;@)
{
my @args = @_;
warn report(REPORT_WARN, @args) if not $quiet_warnings;
}
sub syserr($;@)
{
my ($msg, @args) = @_;
die report(REPORT_ERROR, "$msg: $!", @args);
}
sub error($;@)
{
my @args = @_;
die report(REPORT_ERROR, @args);
}
sub errormsg($;@)
{
my @args = @_;
print { *STDERR } report(REPORT_ERROR, @args);
}
sub printcmd
{
my (@cmd) = @_;
print { *STDERR } report_pretty(" @cmd\n", report_color(REPORT_COMMAND));
}
sub subprocerr(@)
{
my ($p, @args) = @_;
$p = sprintf $p, @args if @args;
require POSIX;
if (POSIX::WIFEXITED($?)) {
my $ret = POSIX::WEXITSTATUS($?);
error(g_('%s subprocess returned exit status %d'), $p, $ret);
} elsif (POSIX::WIFSIGNALED($?)) {
my $sig = POSIX::WTERMSIG($?);
error(g_('%s subprocess was killed by signal %d'), $p, $sig);
} else {
error(g_('%s subprocess failed with unknown status code %d'), $p, $?);
}
}
sub usageerr(@)
{
my ($msg, @args) = @_;
state $printforhelp = g_('Use --help for program usage information.');
$msg = sprintf $msg, @args if @args;
warn report(REPORT_ERROR, $msg);
warn "\n$printforhelp\n";
exit(2);
}
=head1 CHANGES
=head2 Version 0.xx
This is a private module.
=cut
1;
Mini Shell