/[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 7 by dpavlin, Sat Jul 16 16:00:19 2005 UTC revision 29 by dpavlin, Sun Jul 24 11:17:44 2005 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 22  our $VERSION = '0.01'; Line 26  our $VERSION = '0.01';
26  This module defines common functions, and is used as base for other, more  This module defines common functions, and is used as base for other, more
27  specific modules.  specific modules.
28    
  my $webpac = new WebPAC::Common(  
         filter => {  
                 'filter_name_1' => sub {  
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
   }  
   
29  =head1 FUNCTIONS  =head1 FUNCTIONS
30    
31  =head2 fill_in  =head2 progress_bar
   
 Workhourse of all: takes record from in-memory structure of database and  
 strings with placeholders and returns string or array of with substituted  
 values from record.  
   
  my $text = $webpac->fill_in($rec,'v250^a');  
   
 Optional argument is ordinal number for repeatable fields. By default,  
 it's assume to be first repeatable field (fields are perl array, so first  
 element is 0).  
 Following example will read second value from repeatable field.  
   
  my $text = $webpac->fill_in($rec,'Title: v250^a',1);  
32    
33  This function B<does not> perform parsing of format to inteligenty skip  Draw progress bar on STDERR.
 delimiters before fields which aren't used.  
34    
35  This method will automatically decode UTF-8 string to local code page   $webpac->progress_bar($current, $max);
 if needed.  
36    
37  =cut  =cut
38    
39  sub fill_in {  sub progress_bar {
40          my $self = shift;          my $self = shift;
41    
42            my ($curr,$max) = @_;
43    
44          my $log = $self->_get_logger();          my $log = $self->_get_logger();
45    
46          my $rec = shift || $log->logconfess("need data record");          $log->logconfess("no current value!") if (! $curr);
47          my $format = shift || $log->logconfess("need format to parse");          $log->logconfess("no maximum value!") if (! $max);
48          # iteration (for repeatable fields)  
49          my $i = shift || 0;          if ($curr > $max) {
50                    $max = $curr;
51                    $log->debug("overflow to $curr");
52            }
53    
54          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));          $self->{'last_pcnt'} ||= 1;
55            $self->{'start_t'} ||= time();
56    
57          # FIXME remove for speedup?          my $p = int($curr * 100 / $max) || 1;
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
58    
59          if (utf8::is_utf8($format)) {          # reset on re-run
60                  $format = $self->_x($format);          if ($p < $self->{'last_pcnt'}) {
61                    $self->{'last_pcnt'} = $p;
62                    $self->{'start_t'} = time();
63          }          }
64    
65          my $found = 0;          if ($p != $self->{'last_pcnt'}) {
66    
67          my $eval_code;                  my $t = time();
68          # remove eval{...} from beginning                  my $rate = ($curr / ($t - $self->{'start_t'} || 1));
69          $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);                  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          my $filter_name;                  $self->{'last_pcnt'} = $p;
72          # remove filter{...} from beginning                  $self->{'last_curr'} = $curr;
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
   
         # do actual replacement of placeholders  
         # repeatable fields  
         $format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found)/ges;  
         # non-repeatable fields  
         $format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found)/ges;  
   
         if ($found) {  
                 $log->debug("format: $format");  
                 if ($eval_code) {  
                         my $eval = $self->fill_in($rec,$eval_code,$i);  
                         return if (! $self->_eval($eval));  
                 }  
                 if ($filter_name && $self->{'filter'}->{$filter_name}) {  
                         $log->debug("filter '$filter_name' for $format");  
                         $format = $self->{'filter'}->{$filter_name}->($format);  
                         return unless(defined($format));  
                         $log->debug("filter result: $format");  
                 }  
                 # do we have lookups?  
                 if ($self->{'lookup'}) {  
                         return $self->lookup($format);  
                 } else {  
                         return $format;  
                 }  
         } else {  
                 return;  
73          }          }
74            print STDERR "\n" if ($p == 100);
75  }  }
76    
77    =head2 fmt_time
78    
79  =head2 get_data  Format time (in seconds) for display.
   
 Returns value from record.  
80    
81   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);   print $webpac->fmt_time(time());
82    
83  Arguments are:  This method is called by L<progress_bar> to display remaining time.
 record reference C<$rec>,  
 field C<$f>,  
 optional subfiled C<$sf>,  
 index for repeatable values C<$i>.  
   
 Optinal variable C<$found> will be incremeted if there  
 is field.  
   
 Returns value or empty string.  
84    
85  =cut  =cut
86    
87  sub get_data {  sub fmt_time {
88          my $self = shift;          my $self = shift;
89    
90          my ($rec,$f,$sf,$i,$found) = @_;          my $t = shift || 0;
91            my $out = "";
92    
93          if ($$rec->{$f}) {          my ($ss,$mm,$hh) = gmtime($t);
94                  return '' if (! $$rec->{$f}->[$i]);          $out .= "${hh}h" if ($hh);
95                  no strict 'refs';          $out .= sprintf("%02d:%02d", $mm,$ss);
96                  if ($sf && $$rec->{$f}->[$i]->{$sf}) {          $out .= "  " if ($hh == 0);
97                          $$found++ if (defined($$found));          return $out;
                         return $$rec->{$f}->[$i]->{$sf};  
                 } elsif ($$rec->{$f}->[$i]) {  
                         $$found++ if (defined($$found));  
                         # it still might have subfield, just  
                         # not specified, so we'll dump all  
                         if ($$rec->{$f}->[$i] =~ /HASH/o) {  
                                 my $out;  
                                 foreach my $k (keys %{$$rec->{$f}->[$i]}) {  
                                         $out .= $$rec->{$f}->[$i]->{$k}." ";  
                                 }  
                                 return $out;  
                         } else {  
                                 return $$rec->{$f}->[$i];  
                         }  
                 }  
         } else {  
                 return '';  
         }  
98  }  }
99    
100    #
101    #
102    #
103    
104  =head1 INTERNAL METHODS  =head1 INTERNAL METHODS
105    
# Line 196  sub _eval { Line 132  sub _eval {
132          return $ret || undef;          return $ret || undef;
133  }  }
134    
 =head2 _sort_by_order  
   
 Sort xml tags data structure accoding to C<order=""> attribute.  
   
 =cut  
   
 sub _sort_by_order {  
         my $self = shift;  
   
         my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$a};  
         my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$b};  
   
         return $va <=> $vb;  
 }  
   
 =head2 _x  
   
 Convert string from UTF-8 to code page defined in C<import_xml>.  
   
  my $text = $webpac->_x('utf8 text');  
   
 Default application code page is C<ISO-8859-2>. You will probably want to  
 change that when creating new instance of object based on this one.  
   
 =cut  
   
 sub _x {  
         my $self = shift;  
         my $utf8 = shift || return;  
   
         # create UTF-8 convertor for import_xml files  
         $self->{'utf2cp'} ||= Text::Iconv->new('UTF-8' ,$self->{'code_page'} || 'ISO-8859-2');  
   
         return $self->{'utf2cp'}->convert($utf8) ||  
                 $self->_get_logger()->logwarn("can't convert '$utf8'");  
 }  
   
135  =head2 _init_logger  =head2 _init_logger
136    
137  This function will init C<Log::Log4perl> using provided configuration file.  This function will init C<Log::Log4perl> using provided configuration file.
# Line 242  This function will init C<Log::Log4perl> Line 139  This function will init C<Log::Log4perl>
139    $webpac->_init_logger('/path/to/log.conf');    $webpac->_init_logger('/path/to/log.conf');
140    
141  If no path to configuration file is given, dummy empty configuration  If no path to configuration file is given, dummy empty configuration
142  will be create.  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    
145    This function will also read C<log_conf> value from current object and try
146    to read that as configuration file if it exists.
147    
148  =cut  =cut
149    
150  sub _init_logger {  sub _init_logger {
151          my $self = shift;          my $self = shift;
152          my $file = shift;          my $file = shift;
153            $file ||= $self->{'log_conf'};
154            $file = 'conf/log.conf';
155            my $name = (caller(2))[3] || caller;
156          if ($file) {          if ($file) {
157                    warn "# $name is using $file logger\n" if ($log_debug);
158                  Log::Log4perl->init($file);                  Log::Log4perl->init($file);
159          } else {          } else {
160                  my $conf = q( );                  my $conf = q( );
161                    if ($self->{'debug'}) {
162                            $conf = << '_log4perl_';
163    
164    log4perl.rootLogger=INFO, SCREEN
165    
166    log4perl.logger.WebPAC.=DEBUG
167    
168    log4perl.appender.SCREEN=Log::Log4perl::Appender::Screen
169    log4perl.appender.SCREEN.layout=PatternLayout
170    log4perl.appender.SCREEN.layout.ConversionPattern=%d %p> %F{1}:%L %M - %m%n
171    
172    _log4perl_
173                            warn "# $name is using debug logger\n" if ($log_debug);
174                    } else {
175                            warn "# $name is using null logger\n" if ($log_debug);
176                    }
177                  Log::Log4perl->init( \$conf );                  Log::Log4perl->init( \$conf );
178          }          }
179  }  }
# Line 270  method Line 191  method
191  sub _get_logger {  sub _get_logger {
192          my $self = shift;          my $self = shift;
193    
194          $self->{'_logger_ok'} ||= $self->_init_logger;          my $name = (caller(2))[3] || caller;
195            $self->{'_logger_'} ||= $self->_init_logger;
196    
197            warn "# get_logger( $name )\n" if ($log_debug);
198    
         my $name = (caller(1))[3] || caller;  
199          return get_logger($name);          return get_logger($name);
200  }  }
201    
Legend:
Removed from v.7  
changed lines
  Added in v.29
  ViewVC Help
Powered by ViewVC 1.1.26