lib/WebPAC/Common.pm

package WebPAC::Common;

use warnings;
use strict;

use Log::Log4perl qw/get_logger :levels/;
use Time::HiRes qw/time/;

# If ture, enable logging debug
my $log_debug = 0;

=head1 NAME

WebPAC::Common - internal methods called from other WebPAC modules

=head1 VERSION

Version 0.04

=cut

our $VERSION = '0.04';

=head1 SYNOPSYS

This module defines common functions, and is used as base for other, more
specific modules.

=head1 FUNCTIONS

=head2 progress_bar

Draw progress bar on STDERR.

 $webpac->progress_bar($current, $max);

=cut

sub progress_bar {
        my $self = shift;

        my ($curr,$max) = @_;

        my $log = $self->_get_logger();

        $self->{last_pcnt_t} ||= time();

        $log->logconfess("no current value!") if (! $curr);
        $log->logconfess("no maximum value!") if (! $max);

        if ($curr > $max) {
                $max = $curr;
                $log->debug("overflow to $curr");
        }

        $self->{'last_pcnt'} ||= 1;
        $self->{'start_t'} ||= time();

        my $p = int($curr * 100 / $max) || 1;

        # reset on re-run
        if ($p < $self->{'last_pcnt'}) {
                $self->{'last_pcnt'} = $p;
                $self->{'start_t'} = time();
        }

        my $t = time();

        if ($p != $self->{'last_pcnt'} || ( $t - $self->{last_pcnt_t} ) > 2 ) {

                my $rate = ($curr / ($t - $self->{'start_t'} || 1));
                my $eta = ($max-$curr) / ($rate || 1);
                printf STDERR ("%5d [%-38s] %-5d %0.1f/s %s\r",$curr,"=" x ($p/3)."$p%>", $max, $rate, $self->fmt_time($eta));
                $self->{'last_pcnt'} = $p;
                $self->{'last_curr'} = $curr;
                $self->{last_pcnt_t} = $t;
        }
        print STDERR "\n" if ($p == 100);
}

=head2 fmt_time

Format time (in seconds) for display.

 print $webpac->fmt_time(time());

This method is called by L<progress_bar> to display remaining time.

=cut

sub fmt_time {
        my $self = shift;

        my $t = shift || 0;
        my $out = "";

        my ($ss,$mm,$hh) = gmtime($t);
        $out .= "${hh}h" if ($hh);
        $out .= sprintf("%02d:%02d", $mm,$ss);
        $out .= "  " if ($hh == 0);
        return $out;
}

#
#
#

=head1 INTERNAL METHODS

Here is a quick list of internal methods, mostly useful to turn debugging
on them (see L<LOGGING> below for explanation).

=cut

=head2 _eval

Internal function to eval code without C<strict 'subs'>.

=cut

sub _eval {
        my $self = shift;

        my $code = shift || return;

        my $log = $self->_get_logger();

        no strict 'subs';
        my $ret = eval $code;
        if ($@) {
                $log->error("problem with eval code [$code]: $@");
        }

        $log->debug("eval: ",$code," [",$ret,"]");

        return $ret || undef;
}

=head2 _init_logger

This function will init C<Log::Log4perl> using provided configuration file.

  $webpac->_init_logger('/path/to/log.conf');

If no path to configuration file is given, dummy empty configuration
will be created. If any mode which inherits from this one is called
with C<debug> flag, it will turn logging to debug level.

This function will also read C<log_conf> value from current object and try
to read that as configuration file if it exists, if it doesn't it will
fallback to default C<conf/log.conf>.

You can disable all logging by adding C<no_log> to constructor of WebPAC
object. Object in C<Test::Exception> class will disable logging
automatically.

=cut

sub _init_logger {
        my $self = shift;
        my $file = shift;
        $file ||= $self->{'log_conf'};
        $file = 'conf/log.conf';
        my $name = (caller(2))[3] || caller;

        my $conf = q( );
        if ($self->{'no_log'}) {
                warn "# $name disabled logging\n" if ($log_debug);
        } elsif ($self->{'debug'}) {
                $conf = << '_log4perl_';

log4perl.rootLogger=INFO, SCREEN

log4perl.logger.WebPAC.=DEBUG

log4perl.appender.SCREEN=Log::Log4perl::Appender::Screen
log4perl.appender.SCREEN.layout=PatternLayout
log4perl.appender.SCREEN.layout.ConversionPattern=%d %p> %F{1}:%L %M - %m%n

_log4perl_
                warn "# $name is using debug logger\n" if ($log_debug);
        } elsif ($name =~ m/Test::Exception/o) {
                warn "# disabled logging for Text::Exception\n" if ($log_debug);
        } elsif (-e $file) {
                warn "# $name is using $file logger\n" if ($log_debug);
                Log::Log4perl->init($file);
                return 1;
        } else {
                warn "# $name is using null logger\n" if ($log_debug);
        }
        Log::Log4perl->init( \$conf );

        return 1;
}


=head2 _get_logger

Get C<Log::Log4perl> object with a twist: domains are defined for each
method

 my $log = $webpac->_get_logger();

=cut

my $_logger_seen;

sub _get_logger {
        my $self = shift;

        my $name = (caller(1))[3] || caller;

        # make name full
        my $f = '';
        if ($log_debug) {
                foreach ( 0 .. 5 ) {
                        my $s = (caller($_))[3];
                        $f .= "#### $_ >> $s\n" if ($s);
                }
        }

        $self->{'_logger_'} ||= $self->_init_logger;

        my $log = get_logger( $name );
        warn "# get_logger( $name ) level ", $log->level, "\n$f" if ($log_debug && !defined($_logger_seen->{$name}));
        $_logger_seen->{$name}++;
        return $log;
}


=head2 _log

Quick cludge to make logging object available to scripts which
use webpac line this:

  my $log = _new WebPAC::Common()->_get_logger();

=cut

sub _new {
        my $class = shift;
        my $self = {@_};
        bless($self, $class);

        $self ? return $self : return undef;
}

=head1 LOGGING

Logging in WebPAC is performed by L<Log::Log4perl> with config file
C<log.conf>.

Methods defined above have different levels of logging, so
it's descriptions will be useful to turn (mostry B<debug> logging) on
or off to see why WabPAC isn't perforing as you expect it (it might even
be a bug!).

B<This is different from normal Log4perl behaviour>. To repeat, you can
also use method names, and not only classes (which are just few)
to filter logging.

=cut

1;
1	dpavlin	3	package WebPAC::Common;
2
3			use warnings;
4			use strict;
5
6	dpavlin	16	use Log::Log4perl qw/get_logger :levels/;
7			use Time::HiRes qw/time/;
8	dpavlin	3
9	dpavlin	29	# If ture, enable logging debug
10			my $log_debug = 0;
11
12	dpavlin	3	=head1 NAME
13
14			WebPAC::Common - internal methods called from other WebPAC modules
15
16			=head1 VERSION
17
18	dpavlin	763	Version 0.04
19	dpavlin	3
20			=cut
21
22	dpavlin	763	our $VERSION = '0.04';
23	dpavlin	3
24	dpavlin	6	=head1 SYNOPSYS
25	dpavlin	4
26	dpavlin	6	This module defines common functions, and is used as base for other, more
27			specific modules.
28
29	dpavlin	4	=head1 FUNCTIONS
30
31	dpavlin	9	=head2 progress_bar
32
33			Draw progress bar on STDERR.
34
35			$webpac->progress_bar($current, $max);
36
37			=cut
38
39			sub progress_bar {
40			my $self = shift;
41
42			my ($curr,$max) = @_;
43
44			my $log = $self->_get_logger();
45
46	dpavlin	763	$self->{last_pcnt_t} \|\|= time();
47
48	dpavlin	9	$log->logconfess("no current value!") if (! $curr);
49			$log->logconfess("no maximum value!") if (! $max);
50
51			if ($curr > $max) {
52			$max = $curr;
53			$log->debug("overflow to $curr");
54			}
55
56			$self->{'last_pcnt'} \|\|= 1;
57			$self->{'start_t'} \|\|= time();
58
59			my $p = int($curr * 100 / $max) \|\| 1;
60
61			# reset on re-run
62			if ($p < $self->{'last_pcnt'}) {
63			$self->{'last_pcnt'} = $p;
64			$self->{'start_t'} = time();
65			}
66
67	dpavlin	763	my $t = time();
68	dpavlin	9
69	dpavlin	763	if ($p != $self->{'last_pcnt'} \|\| ( $t - $self->{last_pcnt_t} ) > 2 ) {
70
71	dpavlin	9	my $rate = ($curr / ($t - $self->{'start_t'} \|\| 1));
72			my $eta = ($max-$curr) / ($rate \|\| 1);
73			printf STDERR ("%5d [%-38s] %-5d %0.1f/s %s\r",$curr,"=" x ($p/3)."$p%>", $max, $rate, $self->fmt_time($eta));
74			$self->{'last_pcnt'} = $p;
75			$self->{'last_curr'} = $curr;
76	dpavlin	763	$self->{last_pcnt_t} = $t;
77	dpavlin	9	}
78			print STDERR "\n" if ($p == 100);
79			}
80
81			=head2 fmt_time
82
83			Format time (in seconds) for display.
84
85			print $webpac->fmt_time(time());
86
87			This method is called by L<progress_bar> to display remaining time.
88
89			=cut
90
91			sub fmt_time {
92			my $self = shift;
93
94			my $t = shift \|\| 0;
95			my $out = "";
96
97			my ($ss,$mm,$hh) = gmtime($t);
98			$out .= "${hh}h" if ($hh);
99			$out .= sprintf("%02d:%02d", $mm,$ss);
100			$out .= " " if ($hh == 0);
101			return $out;
102			}
103
104			#
105			#
106			#
107
108	dpavlin	3	=head1 INTERNAL METHODS
109
110			Here is a quick list of internal methods, mostly useful to turn debugging
111			on them (see L<LOGGING> below for explanation).
112
113			=cut
114
115			=head2 _eval
116
117			Internal function to eval code without C<strict 'subs'>.
118
119			=cut
120
121			sub _eval {
122			my $self = shift;
123
124			my $code = shift \|\| return;
125
126			my $log = $self->_get_logger();
127
128			no strict 'subs';
129			my $ret = eval $code;
130			if ($@) {
131			$log->error("problem with eval code [$code]: $@");
132			}
133
134			$log->debug("eval: ",$code," [",$ret,"]");
135
136			return $ret \|\| undef;
137			}
138
139			=head2 _init_logger
140
141			This function will init C<Log::Log4perl> using provided configuration file.
142
143			$webpac->_init_logger('/path/to/log.conf');
144
145	dpavlin	6	If no path to configuration file is given, dummy empty configuration
146	dpavlin	10	will be created. If any mode which inherits from this one is called
147			with C<debug> flag, it will turn logging to debug level.
148	dpavlin	6
149	dpavlin	29	This function will also read C<log_conf> value from current object and try
150	dpavlin	31	to read that as configuration file if it exists, if it doesn't it will
151			fallback to default C<conf/log.conf>.
152	dpavlin	29
153	dpavlin	31	You can disable all logging by adding C<no_log> to constructor of WebPAC
154			object. Object in C<Test::Exception> class will disable logging
155			automatically.
156
157	dpavlin	3	=cut
158
159			sub _init_logger {
160			my $self = shift;
161			my $file = shift;
162	dpavlin	29	$file \|\|= $self->{'log_conf'};
163			$file = 'conf/log.conf';
164			my $name = (caller(2))[3] \|\| caller;
165	dpavlin	10
166	dpavlin	31	my $conf = q( );
167			if ($self->{'no_log'}) {
168			warn "# $name disabled logging\n" if ($log_debug);
169			} elsif ($self->{'debug'}) {
170			$conf = << '_log4perl_';
171
172	dpavlin	10	log4perl.rootLogger=INFO, SCREEN
173
174			log4perl.logger.WebPAC.=DEBUG
175
176			log4perl.appender.SCREEN=Log::Log4perl::Appender::Screen
177			log4perl.appender.SCREEN.layout=PatternLayout
178			log4perl.appender.SCREEN.layout.ConversionPattern=%d %p> %F{1}:%L %M - %m%n
179
180			_log4perl_
181	dpavlin	31	warn "# $name is using debug logger\n" if ($log_debug);
182	dpavlin	73	} elsif ($name =~ m/Test::Exception/o) {
183	dpavlin	32	warn "# disabled logging for Text::Exception\n" if ($log_debug);
184	dpavlin	73	} elsif (-e $file) {
185	dpavlin	31	warn "# $name is using $file logger\n" if ($log_debug);
186			Log::Log4perl->init($file);
187	dpavlin	73	return 1;
188	dpavlin	31	} else {
189			warn "# $name is using null logger\n" if ($log_debug);
190	dpavlin	3	}
191	dpavlin	31	Log::Log4perl->init( \$conf );
192
193			return 1;
194	dpavlin	3	}
195
196
197			=head2 _get_logger
198
199			Get C<Log::Log4perl> object with a twist: domains are defined for each
200			method
201
202			my $log = $webpac->_get_logger();
203
204			=cut
205
206	dpavlin	632	my $_logger_seen;
207
208	dpavlin	3	sub _get_logger {
209			my $self = shift;
210
211	dpavlin	633	my $name = (caller(1))[3] \|\| caller;
212
213			# make name full
214			my $f = '';
215			if ($log_debug) {
216			foreach ( 0 .. 5 ) {
217			my $s = (caller($_))[3];
218			$f .= "#### $_ >> $s\n" if ($s);
219			}
220			}
221
222	dpavlin	29	$self->{'_logger_'} \|\|= $self->_init_logger;
223	dpavlin	3
224	dpavlin	363	my $log = get_logger( $name );
225	dpavlin	633	warn "# get_logger( $name ) level ", $log->level, "\n$f" if ($log_debug && !defined($_logger_seen->{$name}));
226	dpavlin	632	$_logger_seen->{$name}++;
227	dpavlin	363	return $log;
228	dpavlin	3	}
229
230
231	dpavlin	254	=head2 _log
232
233			Quick cludge to make logging object available to scripts which
234			use webpac line this:
235
236			my $log = _new WebPAC::Common()->_get_logger();
237
238			=cut
239
240			sub _new {
241	dpavlin	594	my $class = shift;
242			my $self = {@_};
243	dpavlin	254	bless($self, $class);
244
245			$self ? return $self : return undef;
246			}
247
248	dpavlin	3	=head1 LOGGING
249
250			Logging in WebPAC is performed by L<Log::Log4perl> with config file
251			C<log.conf>.
252
253			Methods defined above have different levels of logging, so
254			it's descriptions will be useful to turn (mostry B<debug> logging) on
255			or off to see why WabPAC isn't perforing as you expect it (it might even
256			be a bug!).
257
258			B<This is different from normal Log4perl behaviour>. To repeat, you can
259			also use method names, and not only classes (which are just few)
260			to filter logging.
261
262	dpavlin	632	=cut
263	dpavlin	3
264	dpavlin	632	1;