lib/WebPAC/Common.pm

package WebPAC::Common;

use warnings;
use strict;

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

# 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;
}

=head2 fill_in

Fill in variable names by values

  print $webpac->fill_in( 'foo = $foo bar = $bar',
        foo => 42, bar => 11,
  );

=cut

sub fill_in {
        my $self = shift;

        my $format = shift || die "no format?";
        my $d = {@_};

        foreach my $n ( keys %$d ) {
                $format =~ s/\$\Q$n\E/$d->{$n}/gs;
        }

        die "unknown variables in '$format' input data = ", dump( $d ) if ( $format =~ m/\$\w+/ );

        return $format;
}

#
#
#

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