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
|
package CPANPLUS::Error;
use strict;
use Log::Message private => 0;;
=pod
=head1 NAME
CPANPLUS::Error
=head1 SYNOPSIS
use CPANPLUS::Error qw[cp_msg cp_error];
=head1 DESCRIPTION
This module provides the error handling code for the CPANPLUS
libraries, and is mainly intended for internal use.
=head1 FUNCTIONS
=head2 cp_msg("message string" [,VERBOSE])
Records a message on the stack, and prints it to C<STDOUT> (or actually
C<$MSG_FH>, see the C<GLOBAL VARIABLES> section below), if the
C<VERBOSE> option is true.
The C<VERBOSE> option defaults to false.
=head2 msg()
An alias for C<cp_msg>.
=head2 cp_error("error string" [,VERBOSE])
Records an error on the stack, and prints it to C<STDERR> (or actually
C<$ERROR_FH>, see the C<GLOBAL VARIABLES> sections below), if the
C<VERBOSE> option is true.
The C<VERBOSE> options defaults to true.
=head2 error()
An alias for C<cp_error>.
=head1 CLASS METHODS
=head2 CPANPLUS::Error->stack()
Retrieves all the items on the stack. Since C<CPANPLUS::Error> is
implemented using C<Log::Message>, consult its manpage for the
function C<retrieve> to see what is returned and how to use the items.
=head2 CPANPLUS::Error->stack_as_string([TRACE])
Returns the whole stack as a printable string. If the C<TRACE> option is
true all items are returned with C<Carp::longmess> output, rather than
just the message.
C<TRACE> defaults to false.
=head2 CPANPLUS::Error->flush()
Removes all the items from the stack and returns them. Since
C<CPANPLUS::Error> is implemented using C<Log::Message>, consult its
manpage for the function C<retrieve> to see what is returned and how
to use the items.
=cut
BEGIN {
use Exporter;
use Params::Check qw[check];
use vars qw[@EXPORT @ISA $ERROR_FH $MSG_FH];
@ISA = 'Exporter';
@EXPORT = qw[cp_error cp_msg error msg];
my $log = new Log::Message;
for my $func ( @EXPORT ) {
no strict 'refs';
my $prefix = 'cp_';
my $name = $func;
$name =~ s/^$prefix//g;
*$func = sub {
my $msg = shift;
### no point storing non-messages
return unless defined $msg;
$log->store(
message => $msg,
tag => uc $name,
level => $prefix . $name,
extra => [@_]
);
};
}
sub flush {
my @foo = $log->flush;
return unless @foo;
return reverse @foo;
}
sub stack {
return $log->retrieve( chrono => 1 );
}
sub stack_as_string {
my $class = shift;
my $trace = shift() ? 1 : 0;
return join $/, map {
'[' . $_->tag . '] [' . $_->when . '] ' .
($trace ? $_->message . ' ' . $_->longmess
: $_->message);
} __PACKAGE__->stack;
}
}
=head1 GLOBAL VARIABLES
=over 4
=item $ERROR_FH
This is the filehandle all the messages sent to C<error()> are being
printed. This defaults to C<*STDERR>.
=item $MSG_FH
This is the filehandle all the messages sent to C<msg()> are being
printed. This default to C<*STDOUT>.
=back
=cut
local $| = 1;
$ERROR_FH = \*STDERR;
$MSG_FH = \*STDOUT;
package Log::Message::Handlers;
use Carp ();
{
sub cp_msg {
my $self = shift;
my $verbose = shift;
### so you don't want us to print the msg? ###
return if defined $verbose && $verbose == 0;
my $old_fh = select $CPANPLUS::Error::MSG_FH;
print '['. $self->tag . '] ' . $self->message . "\n";
select $old_fh;
return;
}
sub cp_error {
my $self = shift;
my $verbose = shift;
### so you don't want us to print the error? ###
return if defined $verbose && $verbose == 0;
my $old_fh = select $CPANPLUS::Error::ERROR_FH;
### is only going to be 1 for now anyway ###
### C::I may not be loaded, so do a can() check first
my $cb = CPANPLUS::Internals->can('_return_all_objects')
? (CPANPLUS::Internals->_return_all_objects)[0]
: undef;
### maybe we didn't initialize an internals object (yet) ###
my $debug = $cb ? $cb->configure_object->get_conf('debug') : 0;
my $msg = '['. $self->tag . '] ' . $self->message . "\n";
### i'm getting this warning in the test suite:
### Ambiguous call resolved as CORE::warn(), qualify as such or
### use & at CPANPLUS/Error.pm line 57.
### no idea where it's coming from, since there's no 'sub warn'
### anywhere to be found, but i'll mark it explicitly nonetheless
### --kane
print $debug ? Carp::shortmess($msg) : $msg . "\n";
select $old_fh;
return;
}
}
1;
# Local variables:
# c-indentation-style: bsd
# c-basic-offset: 4
# indent-tabs-mode: nil
# End:
# vim: expandtab shiftwidth=4:
|
