/usr/share/perl5/autodie/exception.pm is in libautodie-perl 2.23-1.
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 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 | package autodie::exception;
use 5.008;
use strict;
use warnings;
use Carp qw(croak);
our $VERSION = '2.23'; # VERSION: Generated by DZP::OurPkg:Version
# ABSTRACT: Exceptions from autodying functions.
our $DEBUG = 0;
use overload
q{""} => "stringify"
;
# Overload smart-match only if we're using 5.10
use if ($] >= 5.010), overload => '~~' => "matches";
my $PACKAGE = __PACKAGE__; # Useful to have a scalar for hash keys.
=head1 NAME
autodie::exception - Exceptions from autodying functions.
=head1 SYNOPSIS
eval {
use autodie;
open(my $fh, '<', 'some_file.txt');
...
};
if (my $E = $@) {
say "Ooops! ",$E->caller," had problems: $@";
}
=head1 DESCRIPTION
When an L<autodie> enabled function fails, it generates an
C<autodie::exception> object. This can be interrogated to
determine further information about the error that occurred.
This document is broken into two sections; those methods that
are most useful to the end-developer, and those methods for
anyone wishing to subclass or get very familiar with
C<autodie::exception>.
=head2 Common Methods
These methods are intended to be used in the everyday dealing
of exceptions.
The following assume that the error has been copied into
a separate scalar:
if ($E = $@) {
...
}
This is not required, but is recommended in case any code
is called which may reset or alter C<$@>.
=cut
=head3 args
my $array_ref = $E->args;
Provides a reference to the arguments passed to the subroutine
that died.
=cut
sub args { return $_[0]->{$PACKAGE}{args}; }
=head3 function
my $sub = $E->function;
The subroutine (including package) that threw the exception.
=cut
sub function { return $_[0]->{$PACKAGE}{function}; }
=head3 file
my $file = $E->file;
The file in which the error occurred (eg, C<myscript.pl> or
C<MyTest.pm>).
=cut
sub file { return $_[0]->{$PACKAGE}{file}; }
=head3 package
my $package = $E->package;
The package from which the exceptional subroutine was called.
=cut
sub package { return $_[0]->{$PACKAGE}{package}; }
=head3 caller
my $caller = $E->caller;
The subroutine that I<called> the exceptional code.
=cut
sub caller { return $_[0]->{$PACKAGE}{caller}; }
=head3 line
my $line = $E->line;
The line in C<< $E->file >> where the exceptional code was called.
=cut
sub line { return $_[0]->{$PACKAGE}{line}; }
=head3 context
my $context = $E->context;
The context in which the subroutine was called by autodie; usually
the same as the context in which you called the autodying subroutine.
This can be 'list', 'scalar', or undefined (unknown). It will never
be 'void', as C<autodie> always captures the return value in one way
or another.
For some core functions that always return a scalar value regardless
of their context (eg, C<chown>), this may be 'scalar', even if you
used a list context.
=cut
# TODO: The comments above say this can be undefined. Is that actually
# the case? (With 'system', perhaps?)
sub context { return $_[0]->{$PACKAGE}{context} }
=head3 return
my $return_value = $E->return;
The value(s) returned by the failed subroutine. When the subroutine
was called in a list context, this will always be a reference to an
array containing the results. When the subroutine was called in
a scalar context, this will be the actual scalar returned.
=cut
sub return { return $_[0]->{$PACKAGE}{return} }
=head3 errno
my $errno = $E->errno;
The value of C<$!> at the time when the exception occurred.
B<NOTE>: This method will leave the main C<autodie::exception> class
and become part of a role in the future. You should only call
C<errno> for exceptions where C<$!> would reasonably have been
set on failure.
=cut
# TODO: Make errno part of a role. It doesn't make sense for
# everything.
sub errno { return $_[0]->{$PACKAGE}{errno}; }
=head3 eval_error
my $old_eval_error = $E->eval_error;
The contents of C<$@> immediately after autodie triggered an
exception. This may be useful when dealing with modules such
as L<Text::Balanced> that set (but do not throw) C<$@> on error.
=cut
sub eval_error { return $_[0]->{$PACKAGE}{eval_error}; }
=head3 matches
if ( $e->matches('open') ) { ... }
if ( $e ~~ 'open' ) { ... }
C<matches> is used to determine whether a
given exception matches a particular role. On Perl 5.10,
using smart-match (C<~~>) with an C<autodie::exception> object
will use C<matches> underneath.
An exception is considered to match a string if:
=over 4
=item *
For a string not starting with a colon, the string exactly matches the
package and subroutine that threw the exception. For example,
C<MyModule::log>. If the string does not contain a package name,
C<CORE::> is assumed.
=item *
For a string that does start with a colon, if the subroutine
throwing the exception I<does> that behaviour. For example, the
C<CORE::open> subroutine does C<:file>, C<:io> and C<:all>.
See L<autodie/CATEGORIES> for further information.
=back
=cut
{
my (%cache);
sub matches {
my ($this, $that) = @_;
# TODO - Handle references
croak "UNIMPLEMENTED" if ref $that;
my $sub = $this->function;
if ($DEBUG) {
my $sub2 = $this->function;
warn "Smart-matching $that against $sub / $sub2\n";
}
# Direct subname match.
return 1 if $that eq $sub;
return 1 if $that !~ /:/ and "CORE::$that" eq $sub;
return 0 if $that !~ /^:/;
# Cached match / check tags.
require Fatal;
if (exists $cache{$sub}{$that}) {
return $cache{$sub}{$that};
}
# This rather awful looking line checks to see if our sub is in the
# list of expanded tags, caches it, and returns the result.
return $cache{$sub}{$that} = grep { $_ eq $sub } @{ $this->_expand_tag($that) };
}
}
# This exists primarily so that child classes can override or
# augment it if they wish.
sub _expand_tag {
my ($this, @args) = @_;
return Fatal->_expand_tag(@args);
}
=head2 Advanced methods
The following methods, while usable from anywhere, are primarily
intended for developers wishing to subclass C<autodie::exception>,
write code that registers custom error messages, or otherwise
work closely with the C<autodie::exception> model.
=cut
# The table below records customer formatters.
# TODO - Should this be a package var instead?
# TODO - Should these be in a completely different file, or
# perhaps loaded on demand? Most formatters will never
# get used in most programs.
my %formatter_of = (
'CORE::close' => \&_format_close,
'CORE::open' => \&_format_open,
'CORE::dbmopen' => \&_format_dbmopen,
'CORE::flock' => \&_format_flock,
);
# TODO: Our tests only check LOCK_EX | LOCK_NB is properly
# formatted. Try other combinations and ensure they work
# correctly.
sub _format_flock {
my ($this) = @_;
require Fcntl;
my $filehandle = $this->args->[0];
my $raw_mode = $this->args->[1];
my $mode_type;
my $lock_unlock;
if ($raw_mode & Fcntl::LOCK_EX() ) {
$lock_unlock = "lock";
$mode_type = "for exclusive access";
}
elsif ($raw_mode & Fcntl::LOCK_SH() ) {
$lock_unlock = "lock";
$mode_type = "for shared access";
}
elsif ($raw_mode & Fcntl::LOCK_UN() ) {
$lock_unlock = "unlock";
$mode_type = "";
}
else {
# I've got no idea what they're trying to do.
$lock_unlock = "lock";
$mode_type = "with mode $raw_mode";
}
my $cooked_filehandle;
if ($filehandle and not ref $filehandle) {
# A package filehandle with a name!
$cooked_filehandle = " $filehandle";
}
else {
# Otherwise we have a scalar filehandle.
$cooked_filehandle = '';
}
local $! = $this->errno;
return "Can't $lock_unlock filehandle$cooked_filehandle $mode_type: $!";
}
# Default formatter for CORE::dbmopen
sub _format_dbmopen {
my ($this) = @_;
my @args = @{$this->args};
# TODO: Presently, $args flattens out the (usually empty) hash
# which is passed as the first argument to dbmopen. This is
# a bug in our args handling code (taking a reference to it would
# be better), but for the moment we'll just examine the end of
# our arguments list for message formatting.
my $mode = $args[-1];
my $file = $args[-2];
# If we have a mask, then display it in octal, not decimal.
# We don't do this if it already looks octalish, or doesn't
# look like a number.
if ($mode =~ /^[^\D0]\d+$/) {
$mode = sprintf("0%lo", $mode);
};
local $! = $this->errno;
return "Can't dbmopen(%hash, '$file', $mode): '$!'";
}
# Default formatter for CORE::close
sub _format_close {
my ($this) = @_;
my $close_arg = $this->args->[0];
local $! = $this->errno;
# If we've got an old-style filehandle, mention it.
if ($close_arg and not ref $close_arg) {
return "Can't close filehandle '$close_arg': '$!'";
}
# TODO - This will probably produce an ugly error. Test and fix.
return "Can't close($close_arg) filehandle: '$!'";
}
# Default formatter for CORE::open
use constant _FORMAT_OPEN => "Can't open '%s' for %s: '%s'";
sub _format_open_with_mode {
my ($this, $mode, $file, $error) = @_;
my $wordy_mode;
if ($mode eq '<') { $wordy_mode = 'reading'; }
elsif ($mode eq '>') { $wordy_mode = 'writing'; }
elsif ($mode eq '>>') { $wordy_mode = 'appending'; }
$file = '<undef>' if not defined $file;
return sprintf _FORMAT_OPEN, $file, $wordy_mode, $error if $wordy_mode;
Carp::confess("Internal autodie::exception error: Don't know how to format mode '$mode'.");
}
sub _format_open {
my ($this) = @_;
my @open_args = @{$this->args};
# Use the default formatter for single-arg and many-arg open
if (@open_args <= 1 or @open_args >= 4) {
return $this->format_default;
}
# For two arg open, we have to extract the mode
if (@open_args == 2) {
my ($fh, $file) = @open_args;
if (ref($fh) eq "GLOB") {
$fh = '$fh';
}
my ($mode) = $file =~ m{
^\s* # Spaces before mode
(
(?> # Non-backtracking subexp.
< # Reading
|>>? # Writing/appending
)
)
[^&] # Not an ampersand (which means a dup)
}x;
if (not $mode) {
# Maybe it's a 2-arg open without any mode at all?
# Detect the most simple case for this, where our
# file consists only of word characters.
if ( $file =~ m{^\s*\w+\s*$} ) {
$mode = '<'
}
else {
# Otherwise, we've got no idea what's going on.
# Use the default.
return $this->format_default;
}
}
# Localising $! means perl makes it a pretty error for us.
local $! = $this->errno;
return $this->_format_open_with_mode($mode, $file, $!);
}
# Here we must be using three arg open.
my $file = $open_args[2];
local $! = $this->errno;
my $mode = $open_args[1];
local $@;
my $msg = eval { $this->_format_open_with_mode($mode, $file, $!); };
return $msg if $msg;
# Default message (for pipes and odd things)
return "Can't open '$file' with mode '$open_args[1]': '$!'";
}
=head3 register
autodie::exception->register( 'CORE::open' => \&mysub );
The C<register> method allows for the registration of a message
handler for a given subroutine. The full subroutine name including
the package should be used.
Registered message handlers will receive the C<autodie::exception>
object as the first parameter.
=cut
sub register {
my ($class, $symbol, $handler) = @_;
croak "Incorrect call to autodie::register" if @_ != 3;
$formatter_of{$symbol} = $handler;
}
=head3 add_file_and_line
say "Problem occurred",$@->add_file_and_line;
Returns the string C< at %s line %d>, where C<%s> is replaced with
the filename, and C<%d> is replaced with the line number.
Primarily intended for use by format handlers.
=cut
# Simply produces the file and line number; intended to be added
# to the end of error messages.
sub add_file_and_line {
my ($this) = @_;
return sprintf(" at %s line %d\n", $this->file, $this->line);
}
=head3 stringify
say "The error was: ",$@->stringify;
Formats the error as a human readable string. Usually there's no
reason to call this directly, as it is used automatically if an
C<autodie::exception> object is ever used as a string.
Child classes can override this method to change how they're
stringified.
=cut
sub stringify {
my ($this) = @_;
my $call = $this->function;
if ($DEBUG) {
my $dying_pkg = $this->package;
my $sub = $this->function;
my $caller = $this->caller;
warn "Stringifing exception for $dying_pkg :: $sub / $caller / $call\n";
}
# TODO - This isn't using inheritance. Should it?
if ( my $sub = $formatter_of{$call} ) {
return $sub->($this) . $this->add_file_and_line;
}
return $this->format_default . $this->add_file_and_line;
}
=head3 format_default
my $error_string = $E->format_default;
This produces the default error string for the given exception,
I<without using any registered message handlers>. It is primarily
intended to be called from a message handler when they have
been passed an exception they don't want to format.
Child classes can override this method to change how default
messages are formatted.
=cut
# TODO: This produces ugly errors. Is there any way we can
# dig around to find the actual variable names? I know perl 5.10
# does some dark and terrible magicks to find them for undef warnings.
sub format_default {
my ($this) = @_;
my $call = $this->function;
local $! = $this->errno;
# TODO: This is probably a good idea for CORE, is it
# a good idea for other subs?
# Trim package name off dying sub for error messages.
$call =~ s/.*:://;
# Walk through all our arguments, and...
#
# * Replace undef with the word 'undef'
# * Replace globs with the string '$fh'
# * Quote all other args.
my @args = @{ $this->args() };
foreach my $arg (@args) {
if (not defined($arg)) { $arg = 'undef' }
elsif (ref($arg) eq "GLOB") { $arg = '$fh' }
else { $arg = qq{'$arg'} }
}
# Format our beautiful error.
return "Can't $call(". join(q{, }, @args) . "): $!" ;
# TODO - Handle user-defined errors from hash.
# TODO - Handle default error messages.
}
=head3 new
my $error = autodie::exception->new(
args => \@_,
function => "CORE::open",
errno => $!,
context => 'scalar',
return => undef,
);
Creates a new C<autodie::exception> object. Normally called
directly from an autodying function. The C<function> argument
is required, its the function we were trying to call that
generated the exception. The C<args> parameter is optional.
The C<errno> value is optional. In versions of C<autodie::exception>
1.99 and earlier the code would try to automatically use the
current value of C<$!>, but this was unreliable and is no longer
supported.
Atrributes such as package, file, and caller are determined
automatically, and cannot be specified.
=cut
sub new {
my ($class, @args) = @_;
my $this = {};
bless($this,$class);
# I'd love to use EVERY here, but it causes our code to die
# because it wants to stringify our objects before they're
# initialised, causing everything to explode.
$this->_init(@args);
return $this;
}
sub _init {
my ($this, %args) = @_;
# Capturing errno here is not necessarily reliable.
my $original_errno = $!;
our $init_called = 1;
my $class = ref $this;
# We're going to walk up our call stack, looking for the
# first thing that doesn't look like our exception
# code, autodie/Fatal, or some whacky eval.
my ($package, $file, $line, $sub);
my $depth = 0;
while (1) {
$depth++;
($package, $file, $line, $sub) = CORE::caller($depth);
# Skip up the call stack until we find something outside
# of the Fatal/autodie/eval space.
next if $package->isa('Fatal');
next if $package->isa($class);
next if $package->isa(__PACKAGE__);
# Anything with the 'autodie::skip' role wants us to skip it.
# https://github.com/pjf/autodie/issues/15
next if ($package->can('DOES') and $package->DOES('autodie::skip'));
next if $file =~ /^\(eval\s\d+\)$/;
last;
}
# We now have everything correct, *except* for our subroutine
# name. If it's __ANON__ or (eval), then we need to keep on
# digging deeper into our stack to find the real name. However we
# don't update our other information, since that will be correct
# for our current exception.
my $first_guess_subroutine = $sub;
while (defined $sub and $sub =~ /^\(eval\)$|::__ANON__$/) {
$depth++;
$sub = (CORE::caller($depth))[3];
}
# If we end up falling out the bottom of our stack, then our
# __ANON__ guess is the best we can get. This includes situations
# where we were called from the top level of a program.
if (not defined $sub) {
$sub = $first_guess_subroutine;
}
$this->{$PACKAGE}{package} = $package;
$this->{$PACKAGE}{file} = $file;
$this->{$PACKAGE}{line} = $line;
$this->{$PACKAGE}{caller} = $sub;
$this->{$PACKAGE}{package} = $package;
$this->{$PACKAGE}{errno} = $args{errno} || 0;
$this->{$PACKAGE}{context} = $args{context};
$this->{$PACKAGE}{return} = $args{return};
$this->{$PACKAGE}{eval_error} = $args{eval_error};
$this->{$PACKAGE}{args} = $args{args} || [];
$this->{$PACKAGE}{function}= $args{function} or
croak("$class->new() called without function arg");
return $this;
}
1;
__END__
=head1 SEE ALSO
L<autodie>, L<autodie::exception::system>
=head1 LICENSE
Copyright (C)2008 Paul Fenwick
This is free software. You may modify and/or redistribute this
code under the same terms as Perl 5.10 itself, or, at your option,
any later version of Perl 5.
=head1 AUTHOR
Paul Fenwick E<lt>pjf@perltraining.com.auE<gt>
|