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

Legend:
Removed from v.217  
changed lines
  Added in v.571

  ViewVC Help
Powered by ViewVC 1.1.26