/[webpac2]/trunk/lib/WebPAC/Common.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /trunk/lib/WebPAC/Common.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3 by dpavlin, Sat Jul 16 11:07:38 2005 UTC revision 763 by dpavlin, Wed Oct 25 20:53:14 2006 UTC
# Line 3  package WebPAC::Common; Line 3  package WebPAC::Common;
3  use warnings;  use warnings;
4  use strict;  use strict;
5    
6  use Log::Log4perl qw(get_logger :levels);  use Log::Log4perl qw/get_logger :levels/;
7    use Time::HiRes qw/time/;
8    
9    # If ture, enable logging debug
10    my $log_debug = 0;
11    
12  =head1 NAME  =head1 NAME
13    
# Line 11  WebPAC::Common - internal methods called Line 15  WebPAC::Common - internal methods called
15    
16  =head1 VERSION  =head1 VERSION
17    
18  Version 0.01  Version 0.04
19    
20  =cut  =cut
21    
22  our $VERSION = '0.01';  our $VERSION = '0.04';
23    
24  =head1 INTERNAL METHODS  =head1 SYNOPSYS
25    
26  Here is a quick list of internal methods, mostly useful to turn debugging  This module defines common functions, and is used as base for other, more
27  on them (see L<LOGGING> below for explanation).  specific modules.
28    
29  =cut  =head1 FUNCTIONS
30    
31  =head2 _eval  =head2 progress_bar
32    
33  Internal function to eval code without C<strict 'subs'>.  Draw progress bar on STDERR.
34    
35     $webpac->progress_bar($current, $max);
36    
37  =cut  =cut
38    
39  sub _eval {  sub progress_bar {
40          my $self = shift;          my $self = shift;
41    
42          my $code = shift || return;          my ($curr,$max) = @_;
43    
44          my $log = $self->_get_logger();          my $log = $self->_get_logger();
45    
46          no strict 'subs';          $self->{last_pcnt_t} ||= time();
47          my $ret = eval $code;  
48          if ($@) {          $log->logconfess("no current value!") if (! $curr);
49                  $log->error("problem with eval code [$code]: $@");          $log->logconfess("no maximum value!") if (! $max);
50    
51            if ($curr > $max) {
52                    $max = $curr;
53                    $log->debug("overflow to $curr");
54          }          }
55    
56          $log->debug("eval: ",$code," [",$ret,"]");          $self->{'last_pcnt'} ||= 1;
57            $self->{'start_t'} ||= time();
58    
59          return $ret || undef;          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            my $t = time();
68    
69            if ($p != $self->{'last_pcnt'} || ( $t - $self->{last_pcnt_t} ) > 2 ) {
70    
71                    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                    $self->{last_pcnt_t} = $t;
77            }
78            print STDERR "\n" if ($p == 100);
79  }  }
80    
81  =head2 _sort_by_order  =head2 fmt_time
82    
83  Sort xml tags data structure accoding to C<order=""> attribute.  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  =cut
90    
91  sub _sort_by_order {  sub fmt_time {
92          my $self = shift;          my $self = shift;
93    
94          my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||          my $t = shift || 0;
95                  $self->{'import_xml'}->{'indexer'}->{$a};          my $out = "";
         my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$b};  
96    
97          return $va <=> $vb;          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  =head2 _x  #
105    #
106    #
107    
108    =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  Convert string from UTF-8 to code page defined in C<import_xml>.  =cut
114    
115   my $text = $webpac->_x('utf8 text');  =head2 _eval
116    
117  Default application code page is C<ISO-8859-2>. You will probably want to  Internal function to eval code without C<strict 'subs'>.
 change that when creating new instance of object based on this one.  
118    
119  =cut  =cut
120    
121  sub _x {  sub _eval {
122          my $self = shift;          my $self = shift;
         my $utf8 = shift || return;  
123    
124          # create UTF-8 convertor for import_xml files          my $code = shift || return;
125          $self->{'utf2cp'} ||= Text::Iconv->new('UTF-8' ,$self->{'code_page'} || 'ISO-8859-2');  
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 $self->{'utf2cp'}->convert($utf8) ||          return $ret || undef;
                 $self->_get_logger()->logwarn("can't convert '$utf8'");  
137  }  }
138    
139  =head2 _init_logger  =head2 _init_logger
# Line 93  This function will init C<Log::Log4perl> Line 142  This function will init C<Log::Log4perl>
142    
143    $webpac->_init_logger('/path/to/log.conf');    $webpac->_init_logger('/path/to/log.conf');
144    
145    If no path to configuration file is given, dummy empty configuration
146    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    
149    This function will also read C<log_conf> value from current object and try
150    to read that as configuration file if it exists, if it doesn't it will
151    fallback to default C<conf/log.conf>.
152    
153    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  =cut  =cut
158    
159  sub _init_logger {  sub _init_logger {
160          my $self = shift;          my $self = shift;
161          my $file = shift;          my $file = shift;
162          if ($file) {          $file ||= $self->{'log_conf'};
163            $file = 'conf/log.conf';
164            my $name = (caller(2))[3] || caller;
165    
166            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    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                    warn "# $name is using debug logger\n" if ($log_debug);
182            } elsif ($name =~ m/Test::Exception/o) {
183                    warn "# disabled logging for Text::Exception\n" if ($log_debug);
184            } elsif (-e $file) {
185                    warn "# $name is using $file logger\n" if ($log_debug);
186                  Log::Log4perl->init($file);                  Log::Log4perl->init($file);
187                    return 1;
188          } else {          } else {
189                  my $conf = q( );                  warn "# $name is using null logger\n" if ($log_debug);
                 Log::Log4perl->init( \$conf );  
190          }          }
191            Log::Log4perl->init( \$conf );
192    
193            return 1;
194  }  }
195    
196    
# Line 116  method Line 203  method
203    
204  =cut  =cut
205    
206    my $_logger_seen;
207    
208  sub _get_logger {  sub _get_logger {
209          my $self = shift;          my $self = shift;
210    
         $self->{'_logger_ok'} ||= $self->_init_logger;  
   
211          my $name = (caller(1))[3] || caller;          my $name = (caller(1))[3] || caller;
212          return get_logger($name);  
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            $self->{'_logger_'} ||= $self->_init_logger;
223    
224            my $log = get_logger( $name );
225            warn "# get_logger( $name ) level ", $log->level, "\n$f" if ($log_debug && !defined($_logger_seen->{$name}));
226            $_logger_seen->{$name}++;
227            return $log;
228  }  }
229    
230    
231    =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            my $class = shift;
242            my $self = {@_};
243            bless($self, $class);
244    
245            $self ? return $self : return undef;
246    }
247    
248  =head1 LOGGING  =head1 LOGGING
249    
250  Logging in WebPAC is performed by L<Log::Log4perl> with config file  Logging in WebPAC is performed by L<Log::Log4perl> with config file
# Line 140  B<This is different from normal Log4perl Line 259  B<This is different from normal Log4perl
259  also use method names, and not only classes (which are just few)  also use method names, and not only classes (which are just few)
260  to filter logging.  to filter logging.
261    
262    =cut
263    
264    1;
Legend:
Removed from v.3  
changed lines
  Added in v.763
  ViewVC Help
Powered by ViewVC 1.1.26