lib/WebPAC/Common.pm

package WebPAC::Common;
use Exporter 'import';
@EXPORT = qw/
        force_array
/;

use warnings;
use strict;

use Log::Log4perl qw/get_logger :levels/;
use Time::HiRes qw/time/;
use Data::Dump qw/dump/;
use File::Spec;
use Cwd qw/abs_path/;

use base qw/Class::Accessor/;
__PACKAGE__->mk_accessors( qw/log_debug no_log debug/ );

=head1 NAME

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

=head1 VERSION

Version 0.05

=cut

our $VERSION = '0.05';

=head1 SYNOPSYS

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

my $o = WebPAC::Common->new({
        log_debug => 1,
        no_log => 1,
        debug => 1,
});

Options:

=over 20

=item log_debug

Generate additional debugging log on C<STDERR>

=item no_log

Disable all logging (useful for tests)

=item debug

Use debugging logger which dumps output only yo C<STDERR>

=back


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

#
#
#

=head2 var_path

  my $path = $self->var_path('data_dir', 'data_file', ... );

=cut

my $abs_path;

sub var_path {
        my $self = shift;

        if ( ! $abs_path ) {
#               $abs_path = abs_path( $0 );
#               $abs_path =~ s!/WebPAC/Common\.pm!!;
                $abs_path = '/data/webpac2';
        }

        return File::Spec->catfile($abs_path, 'var', @_);
}

=head1 EXPORTED NETHODS

=head2 force_array

  my @array = force_array( $ref, sub {
        warn "reference is undefined!";
  });

=cut

sub force_array {
        my ( $what, $error ) = @_;
        my @result;
        if ( ref( $what ) eq 'ARRAY' ) {
                @result = @{ $what };
        } elsif ( defined $what ) {
                @result =  ( $what );
        } else {
                $error->() if ref($error) eq 'CODE';
        }
        return @result;
}


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