/[webpac2]/trunk/lib/WebPAC/Normalize.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/Normalize.pm

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

revision 31 by dpavlin, Sun Jul 24 15:03:11 2005 UTC revision 554 by dpavlin, Sat Jul 1 10:19:29 2006 UTC
# Line 1  Line 1 
1  package WebPAC::Normalize;  package WebPAC::Normalize;
2    use Exporter 'import';
3    @EXPORT = qw/
4            _set_rec _set_lookup
5            _get_ds _clean_ds
6            _debug
7    
8            tag search display
9            marc marc_indicators marc_repeatable_subfield
10    
11            rec1 rec2 rec
12            regex prefix suffix surround
13            first lookup join_with
14    /;
15    
16  use warnings;  use warnings;
17  use strict;  use strict;
18  use base 'WebPAC::Common';  
19  use Data::Dumper;  #use base qw/WebPAC::Common/;
20    use Data::Dump qw/dump/;
21    use Encode qw/from_to/;
22    
23    # debugging warn(s)
24    my $debug = 0;
25    
26    
27  =head1 NAME  =head1 NAME
28    
29  WebPAC::Normalize - data mungling for normalisation  WebPAC::Normalize - describe normalisaton rules using sets
30    
31  =head1 VERSION  =head1 VERSION
32    
33  Version 0.01  Version 0.07
34    
35  =cut  =cut
36    
37  our $VERSION = '0.01';  our $VERSION = '0.07';
38    
39  =head1 SYNOPSIS  =head1 SYNOPSIS
40    
41  This package contains code that mungle data to produce normalized format.  This module uses C<conf/normalize/*.pl> files to perform normalisation
42    from input records using perl functions which are specialized for set
43  It contains several assumptions:  processing.
44    
45    Sets are implemented as arrays, and normalisation file is valid perl, which
46    means that you check it's validity before running WebPAC using
47    C<perl -c normalize.pl>.
48    
49    Normalisation can generate multiple output normalized data. For now, supported output
50    types (on the left side of definition) are: C<tag>, C<display>, C<search> and
51    C<marc>.
52    
53  =over  =head1 FUNCTIONS
   
 =item *  
   
 format of fields is defined using C<v123^a> notation for repeatable fields  
 or C<s123^a> for single (or first) value, where C<123> is field number and  
 C<a> is subfield.  
54    
55  =item *  Functions which start with C<_> are private and used by WebPAC internally.
56    All other functions are available for use within normalisation rules.
57    
58  source data records (C<$rec>) have unique identifiers in field C<000>  =head2 data_structure
59    
60  =item *  Return data structure
61    
62  optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be    my $ds = WebPAC::Normalize::data_structure(
63  perl code that is evaluated before producing output (value of field will be          lookup => $lookup->lookup_hash,
64  interpolated before that)          row => $row,
65            rules => $normalize_pl_config,
66            marc_encoding => 'utf-8',
67      );
68    
69  =item *  Options C<lookup>, C<row>, C<rules> and C<log> are mandatory while all
70    other are optional.
71    
72  optional C<filter{filter_name}> at B<begining of format> will apply perl  This function will B<die> if normalizastion can't be evaled.
 code defined as code ref on format after field substitution to producing  
 output  
73    
74  =item *  Since this function isn't exported you have to call it with
75    C<WebPAC::Normalize::data_structure>.
76    
77  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.  =cut
78    
79  =item *  sub data_structure {
80            my $arg = {@_};
81    
82  at end, optional C<format>s rules are resolved. Format rules are similar to          die "need row argument" unless ($arg->{row});
83  C<sprintf> and can also contain C<lookup{...}> which is performed after          die "need normalisation argument" unless ($arg->{rules});
 values are inserted in format.  
84    
85  =back          no strict 'subs';
86            _set_lookup( $arg->{lookup} );
87            _set_rec( $arg->{row} );
88            _clean_ds( %{ $arg } );
89            eval "$arg->{rules}";
90            die "error evaling $arg->{rules}: $@\n" if ($@);
91    
92  This also describes order in which transformations are applied (eval,          return _get_ds();
93  filter, lookup, format) which is important to undestand when deciding how to  }
 solve your data mungling and normalisation process.  
94    
95    =head2 _set_rec
96    
97    Set current record hash
98    
99      _set_rec( $rec );
100    
101  =head1 FUNCTIONS  =cut
102    
103  =head2 new  my $rec;
104    
105  Create new normalisation object  sub _set_rec {
106            $rec = shift or die "no record hash";
107    }
108    
109    my $n = new WebPAC::Normalize::Something(  =head2 _get_ds
         filter => {  
                 'filter_name_1' => sub {  
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
         db => $db_obj,  
         lookup_regex => $lookup->regex,  
         lookup => $lookup_obj,  
   );  
110    
111  Parametar C<filter> defines user supplied snippets of perl code which can  Return hash formatted as data structure
 be use with C<filter{...}> notation.  
112    
113  Recommended parametar C<lookup_regex> is used to enable parsing of lookups    my $ds = _get_ds();
 in structures. If you pass this parametar, you must also pass C<lookup>  
 which is C<WebPAC::Lookup> object.  
114    
115  =cut  =cut
116    
117  sub new {  my ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators);
         my $class = shift;  
         my $self = {@_};  
         bless($self, $class);  
118    
119          my $r = $self->{'lookup_regex'} ? 1 : 0;  sub _get_ds {
120          my $l = $self->{'lookup'} ? 1 : 0;          return $out;
121    }
122    
123          my $log = $self->_get_logger();  =head2 _clean_ds
124    
125          # those two must be in pair  Clean data structure hash for next record
126          if ( ($r & $l) != ($r || $l) ) {  
127                  my $log = $self->_get_logger();    _clean_ds();
                 $log->logdie("lookup_regex and lookup must be in pair");  
         }  
128    
129          $log->logdie("lookup must be WebPAC::Lookup object") if ($self->{'lookup'} && ! $self->{'lookup'}->isa('WebPAC::Lookup'));  =cut
130    
131          $self ? return $self : return undef;  sub _clean_ds {
132            my $a = {@_};
133            ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators) = ();
134            $marc_encoding = $a->{marc_encoding};
135  }  }
136    
137    =head2 _set_lookup
138    
139  =head2 data_structure  Set current lookup hash
140    
141  Create in-memory data structure which represents normalized layout from    _set_lookup( $lookup );
 C<conf/normalize/*.xml>.  
142    
143  This structures are used to produce output.  =cut
144    
145   my @ds = $webpac->data_structure($rec);  my $lookup;
146    
147  B<Note: historical oddity follows>  sub _set_lookup {
148            $lookup = shift;
149    }
150    
151  This method will also set C<< $webpac->{'currnet_filename'} >> if there is  =head2 _get_marc_fields
 C<< <filename> >> tag and C<< $webpac->{'headline'} >> if there is  
 C<< <headline> >> tag.  
152    
153  =cut  Get all fields defined by calls to C<marc>
154    
155  sub data_structure {          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
         my $self = shift;  
156    
157          my $log = $self->_get_logger();  We are using I<magic> which detect repeatable fields only from
158    sequence of field/subfield data generated by normalization.
159    
160          my $rec = shift;  Repeatable field is created when there is second occurence of same subfield or
161          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  if any of indicators are different.
162    
163          my $cache_file;  This is sane for most cases. Something like:
164    
165          if ($self->{'db'}) {    900a-1 900b-1 900c-1
166                  my @ds = $self->{'db'}->load_ds($rec);    900a-2 900b-2
167                  $log->debug("load_ds( rec = ", sub { Dumper($rec) }, ") = ", sub { Dumper(@ds) });    900a-3
                 return @ds if ($#ds > 0);  
                 $log->debug("cache miss, creating");  
         }  
168    
169          undef $self->{'currnet_filename'};  will be created from any combination of:
         undef $self->{'headline'};  
170    
171          my @sorted_tags;    900a-1 900a-2 900a-3 900b-1 900b-2 900c-1
         if ($self->{tags_by_order}) {  
                 @sorted_tags = @{$self->{tags_by_order}};  
         } else {  
                 @sorted_tags = sort { $self->_sort_by_order } keys %{$self->{'import_xml'}->{'indexer'}};  
                 $self->{tags_by_order} = \@sorted_tags;  
         }  
172    
173          my @ds;  and following rules:
174    
175          $log->debug("tags: ",sub { join(", ",@sorted_tags) });    marc('900','a', rec('200','a') );
176      marc('900','b', rec('200','b') );
177      marc('900','c', rec('200','c') );
178    
179          foreach my $field (@sorted_tags) {  which might not be what you have in mind. If you need repeatable subfield,
180    define it using C<marc_repeatable_subfield> like this:
181    
182                  my $row;  ....
183    
184  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  =cut
185    
186                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {  sub _get_marc_fields {
                         my $format = $tag->{'value'} || $tag->{'content'};  
187    
188                          $log->debug("format: $format");          return if (! $marc_record || ref($marc_record) ne 'ARRAY' || $#{ $marc_record } < 0);
189    
190                          my @v;          # first, sort all existing fields
191                          if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {          # XXX might not be needed, but modern perl might randomize elements in hash
192                                  @v = $self->fill_in_to_arr($rec,$format);          my @sorted_marc_record = sort {
193                          } else {                  $a->[0] . $a->[3] cmp $b->[0] . $b->[3]
194                                  @v = $self->parse_to_arr($rec,$format);          } @{ $marc_record };
                         }  
                         next if (! @v);  
195    
196                          if ($tag->{'sort'}) {          # output marc fields
197                                  @v = $self->sort_arr(@v);          my @m;
                         }  
   
                         # use format?  
                         if ($tag->{'format_name'}) {  
                                 @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;  
                         }  
198    
199                          if ($field eq 'filename') {          # count unique field-subfields (used for offset when walking to next subfield)
200                                  $self->{'current_filename'} = join('',@v);          my $u;
201                                  $log->debug("filename: ",$self->{'current_filename'});          map { $u->{ $_->[0] . $_->[3]  }++ } @sorted_marc_record;
                         } elsif ($field eq 'headline') {  
                                 $self->{'headline'} .= join('',@v);  
                                 $log->debug("headline: ",$self->{'headline'});  
                                 next; # don't return headline in data_structure!  
                         }  
202    
203                          # delimiter will join repeatable fields          if ($debug) {
204                          if ($tag->{'delimiter'}) {                  warn "## marc_repeatable_subfield ", dump( $marc_repeatable_subfield ), $/;
205                                  @v = ( join($tag->{'delimiter'}, @v) );                  warn "## marc_record ", dump( $marc_record ), $/;
206                          }                  warn "## sorted_marc_record ", dump( \@sorted_marc_record ), $/;
207                    warn "## subfield count ", dump( $u ), $/;
208            }
209    
210                          # default types          my $len = $#sorted_marc_record;
211                          my @types = qw(display swish);          my $visited;
212                          # override by type attribute          my $i = 0;
213                          @types = ( $tag->{'type'} ) if ($tag->{'type'});          my $field;
   
                         foreach my $type (@types) {  
                                 # append to previous line?  
                                 $log->debug("type: $type ",sub { join(" ",@v) }, $row->{'append'} || 'no append');  
                                 if ($tag->{'append'}) {  
   
                                         # I will delimit appended part with  
                                         # delimiter (or ,)  
                                         my $d = $tag->{'delimiter'};  
                                         # default delimiter  
                                         $d ||= " ";  
   
                                         my $last = pop @{$row->{$type}};  
                                         $d = "" if (! $last);  
                                         $last .= $d . join($d, @v);  
                                         push @{$row->{$type}}, $last;  
   
                                 } else {  
                                         push @{$row->{$type}}, @v;  
                                 }  
                         }  
214    
215            foreach ( 0 .. $len ) {
216    
217                    # find next element which isn't visited
218                    while ($visited->{$i}) {
219                            $i = ($i + 1) % ($len + 1);
220                  }                  }
221    
222                  if ($row) {                  # mark it visited
223                          $row->{'tag'} = $field;                  $visited->{$i}++;
224    
225                          # TODO: name_sigular, name_plural                  my $row = $sorted_marc_record[$i];
                         my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};  
                         $row->{'name'} = $name ? $self->_x($name) : $field;  
   
                         # post-sort all values in field  
                         if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {  
                                 $log->warn("sort at field tag not implemented");  
                         }  
226    
227                          push @ds, $row;                  # field and subfield which is key for
228                    # marc_repeatable_subfield and u
229                    my $fsf = $row->[0] . $row->[3];
230    
231                    if ($debug > 1) {
232    
233                            print "### field so far [", $#$field, "] : ", dump( $field ), " ", $field ? 'T' : 'F', $/;
234                            print "### this [$i]: ", dump( $row ),$/;
235                            print "### sf: ", $row->[3], " vs ", $field->[3],
236                                    $marc_repeatable_subfield->{ $row->[0] . $row->[3] } ? ' (repeatable)' : '', $/,
237                                    if ($#$field >= 0);
238    
                         $log->debug("row $field: ",sub { Dumper($row) });  
239                  }                  }
240    
241          }                  # if field exists
242                    if ( $#$field >= 0 ) {
243                            if (
244                                    $row->[0] ne $field->[0] ||             # field
245                                    $row->[1] ne $field->[1] ||             # i1
246                                    $row->[2] ne $field->[2]                # i2
247                            ) {
248                                    push @m, $field;
249                                    warn "## saved/1 ", dump( $field ),$/ if ($debug);
250                                    $field = $row;
251    
252                            } elsif (
253                                    ( $row->[3] lt $field->[-2] )           # subfield which is not next (e.g. a after c)
254                                    ||
255                                    ( $row->[3] eq $field->[-2] &&          # same subfield, but not repeatable
256                                            ! $marc_repeatable_subfield->{ $fsf }
257                                    )
258                            ) {
259                                    push @m, $field;
260                                    warn "## saved/2 ", dump( $field ),$/ if ($debug);
261                                    $field = $row;
262    
263          $self->{'db'}->save_ds(                          } else {
264                  ds => \@ds,                                  # append new subfields to existing field
265                  current_filename => $self->{'current_filename'},                                  push @$field, ( $row->[3], $row->[4] );
266                  headline => $self->{'headline'},                          }
267          ) if ($self->{'db'});                  } else {
268                            # insert first field
269                            $field = $row;
270                    }
271    
272          $log->debug("ds: ", sub { Dumper(@ds) });                  if (! $marc_repeatable_subfield->{ $fsf }) {
273                            # make step to next subfield
274                            $i = ($i + $u->{ $fsf } ) % ($len + 1);
275                    }
276            }
277    
278          return @ds;          if ($#$field >= 0) {
279                    push @m, $field;
280                    warn "## saved/3 ", dump( $field ),$/ if ($debug);
281            }
282    
283            return @m;
284  }  }
285    
286  =head2 parse  =head2 _debug
287    
288  Perform smart parsing of string, skipping delimiters for fields which aren't  Change level of debug warnings
 defined. It can also eval code in format starting with C<eval{...}> and  
 return output or nothing depending on eval code.  
289    
290   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);    _debug( 2 );
291    
292  =cut  =cut
293    
294  sub parse {  sub _debug {
295          my $self = shift;          my $l = shift;
296            return $debug unless defined($l);
297          my ($rec, $format_utf8, $i) = @_;          $debug = $l;
298    }
         return if (! $format_utf8);  
   
         my $log = $self->_get_logger();  
   
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
   
         $i = 0 if (! $i);  
299    
300          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  =head1 Functions to create C<data_structure>
301    
302          my @out;  Those functions generally have to first in your normalization file.
303    
304          $log->debug("format: $format");  =head2 tag
305    
306          my $eval_code;  Define new tag for I<search> and I<display>.
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
307    
308          my $filter_name;    tag('Title', rec('200','a') );
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
309    
         my $prefix;  
         my $all_found=0;  
310    
311          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  =cut
312    
313                  my $del = $1 || '';  sub tag {
314                  $prefix ||= $del if ($all_found == 0);          my $name = shift or die "tag needs name as first argument";
315            my @o = grep { defined($_) && $_ ne '' } @_;
316            return unless (@o);
317            $out->{$name}->{tag} = $name;
318            $out->{$name}->{search} = \@o;
319            $out->{$name}->{display} = \@o;
320    }
321    
322                  # repeatable index  =head2 display
                 my $r = $i;  
                 $r = 0 if (lc("$2") eq 's');  
323    
324                  my $found = 0;  Define tag just for I<display>
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);  
325    
326                  if ($found) {    @v = display('Title', rec('200','a') );
                         push @out, $del;  
                         push @out, $tmp;  
                         $all_found += $found;  
                 }  
         }  
327    
328          return if (! $all_found);  =cut
329    
330          my $out = join('',@out);  sub display {
331            my $name = shift or die "display needs name as first argument";
332            my @o = grep { defined($_) && $_ ne '' } @_;
333            return unless (@o);
334            $out->{$name}->{tag} = $name;
335            $out->{$name}->{display} = \@o;
336    }
337    
338          if ($out) {  =head2 search
                 # add rest of format (suffix)  
                 $out .= $format;  
339    
340                  # add prefix if not there  Prepare values just for I<search>
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
341    
342                  $log->debug("result: $out");    @v = search('Title', rec('200','a') );
         }  
343    
344          if ($eval_code) {  =cut
                 my $eval = $self->fill_in($rec,$eval_code,$i) || return;  
                 $log->debug("about to eval{$eval} format: $out");  
                 return if (! $self->_eval($eval));  
         }  
           
         if ($filter_name && $self->{'filter'}->{$filter_name}) {  
                 $log->debug("about to filter{$filter_name} format: $out");  
                 $out = $self->{'filter'}->{$filter_name}->($out);  
                 return unless(defined($out));  
                 $log->debug("filter result: $out");  
         }  
345    
346          return $out;  sub search {
347            my $name = shift or die "search needs name as first argument";
348            my @o = grep { defined($_) && $_ ne '' } @_;
349            return unless (@o);
350            $out->{$name}->{tag} = $name;
351            $out->{$name}->{search} = \@o;
352  }  }
353    
354  =head2 parse_to_arr  =head2 marc
355    
356  Similar to C<parse>, but returns array of all repeatable fields  Save value for MARC field
357    
358   my @arr = $webpac->parse_to_arr($rec,'v250^a');    marc('900','a', rec('200','a') );
359    
360  =cut  =cut
361    
362  sub parse_to_arr {  sub marc {
363          my $self = shift;          my $f = shift or die "marc needs field";
364            die "marc field must be numer" unless ($f =~ /^\d+$/);
365    
366          my ($rec, $format_utf8) = @_;          my $sf = shift or die "marc needs subfield";
367    
368          my $log = $self->_get_logger();          foreach (@_) {
369                    my $v = $_;             # make var read-write for Encode
370                    next unless (defined($v) && $v !~ /^\s*$/);
371                    from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
372                    my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
373                    push @{ $marc_record }, [ $f, $i1, $i2, $sf => $v ];
374            }
375    }
376    
377          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  =head2 marc_repeatable_subfield
         return if (! $format_utf8);  
378    
379          my $i = 0;  Save values for MARC repetable subfield
         my @arr;  
380    
381          while (my $v = $self->parse($rec,$format_utf8,$i++)) {    marc_repeatable_subfield('910', 'z', rec('909') );
                 push @arr, $v;  
         }  
382    
383          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  =cut
384    
385          return @arr;  sub marc_repeatable_subfield {
386            my ($f,$sf) = @_;
387            die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);
388            $marc_repeatable_subfield->{ $f . $sf }++;
389            marc(@_);
390  }  }
391    
392    =head2 marc_indicators
393    
394  =head2 fill_in  Set both indicators for MARC field
   
 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.  
395    
396   my $text = $webpac->fill_in($rec,'v250^a');    marc_indicators('900', ' ', 1);
397    
398  Optional argument is ordinal number for repeatable fields. By default,  Any indicator value other than C<0-9> will be treated as undefined.
 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.  
399    
400   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  =cut
401    
402  This function B<does not> perform parsing of format to inteligenty skip  sub marc_indicators {
403  delimiters before fields which aren't used.          my $f = shift || die "marc_indicators need field!\n";
404            my ($i1,$i2) = @_;
405            die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));
406            die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));
407    
408  This method will automatically decode UTF-8 string to local code page          $i1 = ' ' if ($i1 !~ /^\d$/);
409  if needed.          $i2 = ' ' if ($i2 !~ /^\d$/);
410            @{ $marc_indicators->{$f} } = ($i1,$i2);
411    }
412    
 =cut  
413    
414  sub fill_in {  =head1 Functions to extract data from input
         my $self = shift;  
415    
416          my $log = $self->_get_logger();  This function should be used inside functions to create C<data_structure> described
417    above.
418    
419          my $rec = shift || $log->logconfess("need data record");  =head2 rec1
         my $format = shift || $log->logconfess("need format to parse");  
         # iteration (for repeatable fields)  
         my $i = shift || 0;  
420    
421          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));  Return all values in some field
422    
423          # FIXME remove for speedup?    @v = rec1('200')
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
424    
425          if (utf8::is_utf8($format)) {  TODO: order of values is probably same as in source data, need to investigate that
                 $format = $self->_x($format);  
         }  
426    
427          my $found = 0;  =cut
428    
429          my $eval_code;  sub rec1 {
430          # remove eval{...} from beginning          my $f = shift;
431          $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);          return unless (defined($rec) && defined($rec->{$f}));
432            if (ref($rec->{$f}) eq 'ARRAY') {
433          my $filter_name;                  return map {
434          # remove filter{...} from beginning                          if (ref($_) eq 'HASH') {
435          $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);                                  values %{$_};
   
         # 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'}) {  
                         if ($self->{'lookup'}->can('lookup')) {  
                                 return $self->{'lookup'}->lookup($format);  
436                          } else {                          } else {
437                                  $log->warn("Have lookup object but can't invoke lookup method");                                  $_;
438                          }                          }
439                  } else {                  } @{ $rec->{$f} };
440                          return $format;          } elsif( defined($rec->{$f}) ) {
441                  }                  return $rec->{$f};
         } else {  
                 return;  
442          }          }
443  }  }
444    
445    =head2 rec2
446    
447  =head2 fill_in_to_arr  Return all values in specific field and subfield
448    
449  Similar to C<fill_in>, but returns array of all repeatable fields. Usable    @v = rec2('200','a')
 for fields which have lookups, so they shouldn't be parsed but rather  
 C<fill_id>ed.  
   
  my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');  
450    
451  =cut  =cut
452    
453  sub fill_in_to_arr {  sub rec2 {
454          my $self = shift;          my $f = shift;
455            return unless (defined($rec && $rec->{$f}));
456            my $sf = shift;
457            return map { $_->{$sf} } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
458    }
459    
460          my ($rec, $format_utf8) = @_;  =head2 rec
461    
462          my $log = $self->_get_logger();  syntaxtic sugar for
463    
464          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    @v = rec('200')
465          return if (! $format_utf8);    @v = rec('200','a')
466    
467          my $i = 0;  =cut
         my @arr;  
468    
469          while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {  sub rec {
470                  push @arr, @v;          if ($#_ == 0) {
471                    return rec1(@_);
472            } elsif ($#_ == 1) {
473                    return rec2(@_);
474          }          }
   
         $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  
   
         return @arr;  
475  }  }
476    
477    =head2 regex
478    
479  =head2 get_data  Apply regex to some or all values
   
 Returns value from record.  
   
  my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);  
480    
481  Arguments are:    @v = regex( 's/foo/bar/g', @v );
 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.  
482    
483  =cut  =cut
484    
485  sub get_data {  sub regex {
486          my $self = shift;          my $r = shift;
487            my @out;
488          my ($rec,$f,$sf,$i,$found) = @_;          #warn "r: $r\n", dump(\@_);
489            foreach my $t (@_) {
490          if ($$rec->{$f}) {                  next unless ($t);
491                  return '' if (! $$rec->{$f}->[$i]);                  eval "\$t =~ $r";
492                  no strict 'refs';                  push @out, $t if ($t && $t ne '');
                 if ($sf && $$rec->{$f}->[$i]->{$sf}) {  
                         $$found++ if (defined($$found));  
                         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 '';  
493          }          }
494            return @out;
495  }  }
496    
497    =head2 prefix
498    
499  =head2 apply_format  Prefix all values with a string
   
 Apply format specified in tag with C<format_name="name"> and  
 C<format_delimiter=";;">.  
500    
501   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);    @v = prefix( 'my_', @v );
   
 Formats can contain C<lookup{...}> if you need them.  
502    
503  =cut  =cut
504    
505  sub apply_format {  sub prefix {
506          my $self = shift;          my $p = shift or die "prefix needs string as first argument";
507            return map { $p . $_ } grep { defined($_) } @_;
508          my ($name,$delimiter,$data) = @_;  }
   
         my $log = $self->_get_logger();  
   
         if (! $self->{'import_xml'}->{'format'}->{$name}) {  
                 $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});  
                 return $data;  
         }  
   
         $log->warn("no delimiter for format $name") if (! $delimiter);  
509    
510          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  =head2 suffix
511    
512          my @data = split(/\Q$delimiter\E/, $data);  suffix all values with a string
513    
514          my $out = sprintf($format, @data);    @v = suffix( '_my', @v );
         $log->debug("using format $name [$format] on $data to produce: $out");  
515    
516          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {  =cut
                 return $self->{'lookup'}->lookup($out);  
         } else {  
                 return $out;  
         }  
517    
518    sub suffix {
519            my $s = shift or die "suffix needs string as first argument";
520            return map { $_ . $s } grep { defined($_) } @_;
521  }  }
522    
523  =head2 sort_arr  =head2 surround
524    
525  Sort array ignoring case and html in data  surround all values with a two strings
526    
527   my @sorted = $webpac->sort_arr(@unsorted);    @v = surround( 'prefix_', '_suffix', @v );
528    
529  =cut  =cut
530    
531  sub sort_arr {  sub surround {
532          my $self = shift;          my $p = shift or die "surround need prefix as first argument";
533            my $s = shift or die "surround needs suffix as second argument";
534          my $log = $self->_get_logger();          return map { $p . $_ . $s } grep { defined($_) } @_;
   
         # FIXME add Schwartzian Transformation?  
   
         my @sorted = sort {  
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
   
         return @sorted;  
535  }  }
536    
537    =head2 first
538    
539  =head1 INTERNAL METHODS  Return first element
540    
541  =head2 _sort_by_order    $v = first( @v );
   
 Sort xml tags data structure accoding to C<order=""> attribute.  
542    
543  =cut  =cut
544    
545  sub _sort_by_order {  sub first {
546          my $self = shift;          my $r = shift;
547            return $r;
         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;  
548  }  }
549    
550  =head2 _x  =head2 lookup
   
 Convert strings from C<conf/normalize/*.xml> encoding into application  
 specific encoding (optinally specified using C<code_page> to C<new>  
 constructor).  
551    
552   my $text = $n->_x('normalize text string');  Consult lookup hashes for some value
553    
554  This is a stub so that other modules doesn't have to implement it.    @v = lookup( $v );
555      @v = lookup( @v );
556    
557  =cut  =cut
558    
559  sub _x {  sub lookup {
560          my $self = shift;          my $k = shift or return;
561          return shift;          return unless (defined($lookup->{$k}));
562            if (ref($lookup->{$k}) eq 'ARRAY') {
563                    return @{ $lookup->{$k} };
564            } else {
565                    return $lookup->{$k};
566            }
567  }  }
568    
569    =head2 join_with
570    
571  =head1 AUTHOR  Joins walues with some delimiter
   
 Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  
   
 =head1 COPYRIGHT & LICENSE  
572    
573  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.    $v = join_with(", ", @v);
   
 This program is free software; you can redistribute it and/or modify it  
 under the same terms as Perl itself.  
574    
575  =cut  =cut
576    
577  1; # End of WebPAC::DB  sub join_with {
578            my $d = shift;
579            return join($d, grep { defined($_) && $_ ne '' } @_);
580    }
581    
582    # END
583    1;

Legend:
Removed from v.31  
changed lines
  Added in v.554

  ViewVC Help
Powered by ViewVC 1.1.26