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.01

=cut

our $VERSION = '0.01';

=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();

        $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();
        }

        if ($p != $self->{'last_pcnt'}) {

                my $t = time();
                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;
        }
        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";
        } elsif ($file) {
                warn "# $name is using $file logger\n" if ($log_debug);
                Log::Log4perl->init($file);
        } 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

sub _get_logger {
        my $self = shift;

        my $name = (caller(2))[3] || caller;
        $self->{'_logger_'} ||= $self->_init_logger;

        warn "# get_logger( $name )\n" if ($log_debug);

        return get_logger($name);
}


=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.


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			Version 0.01
19
20			=cut
21
22			our $VERSION = '0.01';
23
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			$log->logconfess("no current value!") if (! $curr);
47			$log->logconfess("no maximum value!") if (! $max);
48
49			if ($curr > $max) {
50			$max = $curr;
51			$log->debug("overflow to $curr");
52			}
53
54			$self->{'last_pcnt'} \|\|= 1;
55			$self->{'start_t'} \|\|= time();
56
57			my $p = int($curr * 100 / $max) \|\| 1;
58
59			# reset on re-run
60			if ($p < $self->{'last_pcnt'}) {
61			$self->{'last_pcnt'} = $p;
62			$self->{'start_t'} = time();
63			}
64
65			if ($p != $self->{'last_pcnt'}) {
66
67			my $t = time();
68			my $rate = ($curr / ($t - $self->{'start_t'} \|\| 1));
69			my $eta = ($max-$curr) / ($rate \|\| 1);
70			printf STDERR ("%5d [%-38s] %-5d %0.1f/s %s\r",$curr,"=" x ($p/3)."$p%>", $max, $rate, $self->fmt_time($eta));
71			$self->{'last_pcnt'} = $p;
72			$self->{'last_curr'} = $curr;
73			}
74			print STDERR "\n" if ($p == 100);
75			}
76
77			=head2 fmt_time
78
79			Format time (in seconds) for display.
80
81			print $webpac->fmt_time(time());
82
83			This method is called by L<progress_bar> to display remaining time.
84
85			=cut
86
87			sub fmt_time {
88			my $self = shift;
89
90			my $t = shift \|\| 0;
91			my $out = "";
92
93			my ($ss,$mm,$hh) = gmtime($t);
94			$out .= "${hh}h" if ($hh);
95			$out .= sprintf("%02d:%02d", $mm,$ss);
96			$out .= " " if ($hh == 0);
97			return $out;
98			}
99
100			#
101			#
102			#
103
104	dpavlin	3	=head1 INTERNAL METHODS
105
106			Here is a quick list of internal methods, mostly useful to turn debugging
107			on them (see L<LOGGING> below for explanation).
108
109			=cut
110
111			=head2 _eval
112
113			Internal function to eval code without C<strict 'subs'>.
114
115			=cut
116
117			sub _eval {
118			my $self = shift;
119
120			my $code = shift \|\| return;
121
122			my $log = $self->_get_logger();
123
124			no strict 'subs';
125			my $ret = eval $code;
126			if ($@) {
127			$log->error("problem with eval code [$code]: $@");
128			}
129
130			$log->debug("eval: ",$code," [",$ret,"]");
131
132			return $ret \|\| undef;
133			}
134
135			=head2 _init_logger
136
137			This function will init C<Log::Log4perl> using provided configuration file.
138
139			$webpac->_init_logger('/path/to/log.conf');
140
141	dpavlin	6	If no path to configuration file is given, dummy empty configuration
142	dpavlin	10	will be created. If any mode which inherits from this one is called
143			with C<debug> flag, it will turn logging to debug level.
144	dpavlin	6
145	dpavlin	29	This function will also read C<log_conf> value from current object and try
146	dpavlin	31	to read that as configuration file if it exists, if it doesn't it will
147			fallback to default C<conf/log.conf>.
148	dpavlin	29
149	dpavlin	31	You can disable all logging by adding C<no_log> to constructor of WebPAC
150			object. Object in C<Test::Exception> class will disable logging
151			automatically.
152
153	dpavlin	3	=cut
154
155			sub _init_logger {
156			my $self = shift;
157			my $file = shift;
158	dpavlin	29	$file \|\|= $self->{'log_conf'};
159			$file = 'conf/log.conf';
160			my $name = (caller(2))[3] \|\| caller;
161	dpavlin	10
162	dpavlin	31	my $conf = q( );
163			if ($self->{'no_log'}) {
164			warn "# $name disabled logging\n" if ($log_debug);
165			} elsif ($self->{'debug'}) {
166			$conf = << '_log4perl_';
167
168	dpavlin	10	log4perl.rootLogger=INFO, SCREEN
169
170			log4perl.logger.WebPAC.=DEBUG
171
172			log4perl.appender.SCREEN=Log::Log4perl::Appender::Screen
173			log4perl.appender.SCREEN.layout=PatternLayout
174			log4perl.appender.SCREEN.layout.ConversionPattern=%d %p> %F{1}:%L %M - %m%n
175
176			_log4perl_
177	dpavlin	31	warn "# $name is using debug logger\n" if ($log_debug);
178			} elsif ($name !~ m/Test::Exception/o) {
179			warn "# disabled logging for Text::Exception\n";
180			} elsif ($file) {
181			warn "# $name is using $file logger\n" if ($log_debug);
182			Log::Log4perl->init($file);
183			} else {
184			warn "# $name is using null logger\n" if ($log_debug);
185	dpavlin	3	}
186	dpavlin	31	Log::Log4perl->init( \$conf );
187
188			return 1;
189	dpavlin	3	}
190
191
192			=head2 _get_logger
193
194			Get C<Log::Log4perl> object with a twist: domains are defined for each
195			method
196
197			my $log = $webpac->_get_logger();
198
199			=cut
200
201			sub _get_logger {
202			my $self = shift;
203
204	dpavlin	29	my $name = (caller(2))[3] \|\| caller;
205			$self->{'_logger_'} \|\|= $self->_init_logger;
206	dpavlin	3
207	dpavlin	29	warn "# get_logger( $name )\n" if ($log_debug);
208
209	dpavlin	3	return get_logger($name);
210			}
211
212
213			=head1 LOGGING
214
215			Logging in WebPAC is performed by L<Log::Log4perl> with config file
216			C<log.conf>.
217
218			Methods defined above have different levels of logging, so
219			it's descriptions will be useful to turn (mostry B<debug> logging) on
220			or off to see why WabPAC isn't perforing as you expect it (it might even
221			be a bug!).
222
223			B<This is different from normal Log4perl behaviour>. To repeat, you can
224			also use method names, and not only classes (which are just few)
225			to filter logging.
226
227