/[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 252 by dpavlin, Thu Dec 15 17:01:04 2005 UTC revision 568 by dpavlin, Sun Jul 2 21:30:00 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.04  Version 0.09
37    
38  =cut  =cut
39    
40  our $VERSION = '0.04';  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.  
   
 =item *  
57    
58  source data records (C<$rec>) have unique identifiers in field C<000>  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  =item *  =head2 data_structure
62    
63  optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be  Return data structure
 perl code that is evaluated before producing output (value of field will be  
 interpolated before that)  
64    
65  =item *    my $ds = WebPAC::Normalize::data_structure(
66            lookup => $lookup->lookup_hash,
67            row => $row,
68            rules => $normalize_pl_config,
69            marc_encoding => 'utf-8',
70      );
71    
72  optional C<filter{filter_name}> at B<begining of format> will apply perl  Options C<lookup>, C<row>, C<rules> and C<log> are mandatory while all
73  code defined as code ref on format after field substitution to producing  other are optional.
 output  
74    
75  =item *  This function will B<die> if normalizastion can't be evaled.
76    
77  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.  Since this function isn't exported you have to call it with
78    C<WebPAC::Normalize::data_structure>.
79    
80  =item *  =cut
81    
82  at end, optional C<format>s rules are resolved. Format rules are similar to  sub data_structure {
83  C<sprintf> and can also contain C<lookup{...}> which is performed after          my $arg = {@_};
 values are inserted in format.  
84    
85  =back          die "need row argument" unless ($arg->{row});
86            die "need normalisation argument" unless ($arg->{rules});
87    
88  This also describes order in which transformations are applied (eval,          no strict 'subs';
89  filter, lookup, format) which is important to undestand when deciding how to          _set_lookup( $arg->{lookup} );
90  solve your data mungling and normalisation process.          _set_rec( $arg->{row} );
91            _clean_ds( %{ $arg } );
92            eval "$arg->{rules}";
93            die "error evaling $arg->{rules}: $@\n" if ($@);
94    
95            return _get_ds();
96    }
97    
98    =head2 _set_rec
99    
100    Set current record hash
101    
102  =head1 FUNCTIONS    _set_rec( $rec );
103    
104  =head2 new  =cut
105    
106  Create new normalisation object  my $rec;
107    
108    my $n = new WebPAC::Normalize::Something(  sub _set_rec {
109          filter => {          $rec = shift or die "no record hash";
110                  'filter_name_1' => sub {  }
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
         db => $db_obj,  
         lookup_regex => $lookup->regex,  
         lookup => $lookup_obj,  
         prefix => 'foobar',  
   );  
111    
112  Parametar C<filter> defines user supplied snippets of perl code which can  =head2 _get_ds
 be use with C<filter{...}> notation.  
113    
114  C<prefix> is used to form filename for database record (to support multiple  Return hash formatted as data structure
 source files which are joined in one database).  
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);  
   
         my $r = $self->{'lookup_regex'} ? 1 : 0;  
         my $l = $self->{'lookup'} ? 1 : 0;  
121    
122          my $log = $self->_get_logger();  sub _get_ds {
123            return $out;
124    }
125    
126          # those two must be in pair  =head2 _clean_ds
         if ( ($r & $l) != ($r || $l) ) {  
                 my $log = $self->_get_logger();  
                 $log->logdie("lookup_regex and lookup must be in pair");  
         }  
127    
128          $log->logdie("lookup must be WebPAC::Lookup object") if ($self->{'lookup'} && ! $self->{'lookup'}->isa('WebPAC::Lookup'));  Clean data structure hash for next record
129    
130          $log->warn("no prefix defined. please check that!") unless ($self->{'prefix'});    _clean_ds();
131    
132          $log->debug("using lookup regex: ", $self->{lookup_regex}) if ($r && $l);  =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 $id = $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 => $id, prefix => $self->{prefix} );  
                 $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}++;
229                          # override by type attribute  
230                          @types = ( $tag->{'type'} ) if ($tag->{'type'});                  my $row = $sorted_marc_record[$i];
   
                         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;  
                                 }  
                         }  
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 => $id,  }
290                  ds => $ds,  
291                  prefix => $self->{prefix},  =head2 _debug
         ) if ($self->{'db'});  
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  Perform smart parsing of string, skipping delimiters for fields which aren't  Those functions generally have to first in your normalization file.
309  defined. It can also eval code in format starting with C<eval{...}> and  
310  return output or nothing depending on eval code.  =head2 tag
311    
312    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') );
                 # add rest of format (suffix)  
                 $out .= $format;  
384    
385                  # add prefix if not there  =cut
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
386    
387                  $log->debug("result: $out");  sub marc {
388          }          my $f = shift or die "marc needs field";
389            die "marc field must be numer" unless ($f =~ /^\d+$/);
390    
391          if ($eval_code) {          my $sf = shift or die "marc needs subfield";
                 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");  
         }  
392    
393          return $out;          foreach (@_) {
394                    my $v = $_;             # make var read-write for Encode
395                    next unless (defined($v) && $v !~ /^\s*$/);
396                    from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
397                    my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
398                    push @{ $marc_record }, [ $f, $i1, $i2, $sf => $v ];
399            }
400  }  }
401    
402  =head2 parse_to_arr  =head2 marc_repeatable_subfield
403    
404  Similar to C<parse>, but returns array of all repeatable fields  Save values for MARC repetable subfield
405    
406   my @arr = $webpac->parse_to_arr($rec,'v250^a');    marc_repeatable_subfield('910', 'z', rec('909') );
407    
408  =cut  =cut
409    
410  sub parse_to_arr {  sub marc_repeatable_subfield {
411          my $self = shift;          my ($f,$sf) = @_;
412            die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);
413            $marc_repeatable_subfield->{ $f . $sf }++;
414            marc(@_);
415    }
416    
417          my ($rec, $format_utf8) = @_;  =head2 marc_indicators
418    
419          my $log = $self->_get_logger();  Set both indicators for MARC field
420    
421          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    marc_indicators('900', ' ', 1);
         return if (! $format_utf8);  
422    
423          my $i = 0;  Any indicator value other than C<0-9> will be treated as undefined.
         my @arr;  
424    
425          while (my $v = $self->parse($rec,$format_utf8,$i++)) {  =cut
                 push @arr, $v;  
         }  
426    
427          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  sub marc_indicators {
428            my $f = shift || die "marc_indicators need field!\n";
429            my ($i1,$i2) = @_;
430            die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));
431            die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));
432    
433          return @arr;          $i1 = ' ' if ($i1 !~ /^\d$/);
434            $i2 = ' ' if ($i2 !~ /^\d$/);
435            @{ $marc_indicators->{$f} } = ($i1,$i2);
436  }  }
437    
438    =head2 marc_compose
439    
440  =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.  
441    
442   my $text = $webpac->fill_in($rec,'v250^a');    marc_compose('900',
443            'a', rec('200','a')
444            'b', rec('201','a')
445            'a', rec('200','b')
446            'c', rec('200','c')
447      );
448    
449  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.  
450    
451   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  sub marc_compose {
452            my $f = shift or die "marc_compose needs field";
453            die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
454    
455  This function B<does not> perform parsing of format to inteligenty skip          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
456  delimiters before fields which aren't used.          my $m = [ $f, $i1, $i2 ];
457    
458  This method will automatically decode UTF-8 string to local code page          while (@_) {
459  if needed.                  my $sf = shift or die "marc_compose $f needs subfield";
460                    my $v = shift;
461    
462  =cut                  next unless (defined($v) && $v !~ /^\s*$/);
463                    from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
464                    push @$m, ( $sf, $v );
465                    warn "## ++ marc_compose($f,$sf,$v) ", dump( $m ),$/ if ($debug > 1);
466            }
467    
468  sub fill_in {          warn "## marc_compose(d) ", dump( $m ),$/ if ($debug > 1);
         my $self = shift;  
469    
470          my $log = $self->_get_logger();          push @{ $marc_record }, $m if ($#{$m} > 2);
471    }
472    
         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;  
473    
474          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));  =head1 Functions to extract data from input
475    
476          # FIXME remove for speedup?  This function should be used inside functions to create C<data_structure> described
477          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  above.
478    
479          if (utf8::is_utf8($format)) {  =head2 rec1
                 $format = $self->_x($format);  
         }  
480    
481          my $found = 0;  Return all values in some field
482    
483          my $eval_code;    @v = rec1('200')
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
484    
485          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);  
486    
487          # 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;  
488    
489          if ($found) {  sub rec1 {
490                  $log->debug("format: $format");          my $f = shift;
491                  if ($eval_code) {          return unless (defined($rec) && defined($rec->{$f}));
492                          my $eval = $self->fill_in($rec,$eval_code,$i);          if (ref($rec->{$f}) eq 'ARRAY') {
493                          return if (! $self->_eval($eval));                  return map {
494                  }                          if (ref($_) eq 'HASH') {
495                  if ($filter_name && $self->{'filter'}->{$filter_name}) {                                  values %{$_};
                         $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')) {  
                                 my @lookup = $self->{lookup}->lookup($format);  
                                 $log->debug('lookup $format', join(", ", @lookup));  
                                 return @lookup;  
496                          } else {                          } else {
497                                  $log->warn("Have lookup object but can't invoke lookup method");                                  $_;
498                          }                          }
499                  } else {                  } @{ $rec->{$f} };
500                          return $format;          } elsif( defined($rec->{$f}) ) {
501                  }                  return $rec->{$f};
         } else {  
                 return;  
502          }          }
503  }  }
504    
505    =head2 rec2
506    
507  =head2 fill_in_to_arr  Return all values in specific field and subfield
508    
509  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]');  
510    
511  =cut  =cut
512    
513  sub fill_in_to_arr {  sub rec2 {
514          my $self = shift;          my $f = shift;
515            return unless (defined($rec && $rec->{$f}));
516            my $sf = shift;
517            return map { $_->{$sf} } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
518    }
519    
520          my ($rec, $format_utf8) = @_;  =head2 rec
521    
522          my $log = $self->_get_logger();  syntaxtic sugar for
523    
524          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    @v = rec('200')
525          return if (! $format_utf8);    @v = rec('200','a')
526    
527          my $i = 0;  =cut
         my @arr;  
528    
529          while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {  sub rec {
530                  push @arr, @v;          if ($#_ == 0) {
531                    return rec1(@_);
532            } elsif ($#_ == 1) {
533                    return rec2(@_);
534          }          }
   
         $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  
   
         return @arr;  
535  }  }
536    
537    =head2 regex
538    
539  =head2 get_data  Apply regex to some or all values
   
 Returns value from record.  
   
  my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);  
540    
541  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.  
542    
543  =cut  =cut
544    
545  sub get_data {  sub regex {
546          my $self = shift;          my $r = shift;
547            my @out;
548          my ($rec,$f,$sf,$i,$found) = @_;          #warn "r: $r\n", dump(\@_);
549            foreach my $t (@_) {
550          if ($$rec->{$f}) {                  next unless ($t);
551                  return '' if (! $$rec->{$f}->[$i]);                  eval "\$t =~ $r";
552                  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 '';  
553          }          }
554            return @out;
555  }  }
556    
557    =head2 prefix
558    
559  =head2 apply_format  Prefix all values with a string
   
 Apply format specified in tag with C<format_name="name"> and  
 C<format_delimiter=";;">.  
560    
561   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);    @v = prefix( 'my_', @v );
   
 Formats can contain C<lookup{...}> if you need them.  
562    
563  =cut  =cut
564    
565  sub apply_format {  sub prefix {
566          my $self = shift;          my $p = shift or die "prefix needs string as first argument";
567            return map { $p . $_ } grep { defined($_) } @_;
568    }
569    
570          my ($name,$delimiter,$data) = @_;  =head2 suffix
571    
572          my $log = $self->_get_logger();  suffix all values with a string
573    
574          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;  
         }  
575    
576          $log->warn("no delimiter for format $name") if (! $delimiter);  =cut
577    
578          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  sub suffix {
579            my $s = shift or die "suffix needs string as first argument";
580            return map { $_ . $s } grep { defined($_) } @_;
581    }
582    
583          my @data = split(/\Q$delimiter\E/, $data);  =head2 surround
584    
585          my $out = sprintf($format, @data);  surround all values with a two strings
         $log->debug("using format $name [$format] on $data to produce: $out");  
586    
587          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {    @v = surround( 'prefix_', '_suffix', @v );
588                  return $self->{'lookup'}->lookup($out);  
589          } else {  =cut
                 return $out;  
         }  
590    
591    sub surround {
592            my $p = shift or die "surround need prefix as first argument";
593            my $s = shift or die "surround needs suffix as second argument";
594            return map { $p . $_ . $s } grep { defined($_) } @_;
595  }  }
596    
597  =head2 sort_arr  =head2 first
598    
599  Sort array ignoring case and html in data  Return first element
600    
601   my @sorted = $webpac->sort_arr(@unsorted);    $v = first( @v );
602    
603  =cut  =cut
604    
605  sub sort_arr {  sub first {
606          my $self = shift;          my $r = shift;
607            return $r;
608    }
609    
610          my $log = $self->_get_logger();  =head2 lookup
611    
612          # FIXME add Schwartzian Transformation?  Consult lookup hashes for some value
613    
614          my @sorted = sort {    @v = lookup( $v );
615                  $a =~ s#<[^>]+/*>##;    @v = lookup( @v );
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
616    
617          return @sorted;  =cut
 }  
618    
619    sub lookup {
620            my $k = shift or return;
621            return unless (defined($lookup->{$k}));
622            if (ref($lookup->{$k}) eq 'ARRAY') {
623                    return @{ $lookup->{$k} };
624            } else {
625                    return $lookup->{$k};
626            }
627    }
628    
629  =head1 INTERNAL METHODS  =head2 join_with
630    
631  =head2 _sort_by_order  Joins walues with some delimiter
632    
633  Sort xml tags data structure accoding to C<order=""> attribute.    $v = join_with(", ", @v);
634    
635  =cut  =cut
636    
637  sub _sort_by_order {  sub join_with {
638          my $self = shift;          my $d = shift;
639            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;  
640  }  }
641    
642  =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).  
643    
644   my $text = $n->_x('normalize text string');  Split record subfield on some regex and take one of parts out
645    
646  This is a stub so that other modules doesn't have to implement it.    $a_before_semi_column =
647            split_rec_on('200','a', /\s*;\s*/, $part);
648    
649  =cut  C<$part> is optional number of element. First element is
650    B<1>, not 0!
 sub _x {  
         my $self = shift;  
         return shift;  
 }  
651    
652    If there is no C<$part> parameter or C<$part> is 0, this function will
653    return all values produced by splitting.
654    
655  =head1 AUTHOR  =cut
656    
657  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  sub split_rec_on {
658            die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
659    
660  =head1 COPYRIGHT & LICENSE          my ($fld, $sf, $regex, $part) = @_;
661            warn "### regex ", ref($regex), $regex, $/ if ($debug > 2);
662    
663  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.          my @r = rec( $fld, $sf );
664            my $v = shift @r;
665            warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
666    
667  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.  
668    
669  =cut          my @s = split( $regex, $v );
670            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
671            if ($part && $part > 0) {
672                    return $s[ $part - 1 ];
673            } else {
674                    return [ @s ];
675            }
676    }
677    
678  1; # End of WebPAC::Normalize  # END
679    1;

Legend:
Removed from v.252  
changed lines
  Added in v.568

  ViewVC Help
Powered by ViewVC 1.1.26