/[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 371 by dpavlin, Sun Jan 8 21:16:27 2006 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 blib;  
22  use WebPAC::Common;  #use base qw/WebPAC::Common/;
23  use base 'WebPAC::Common';  use Data::Dump qw/dump/;
24  use Data::Dumper;  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.08  Version 0.09
37    
38  =cut  =cut
39    
40  our $VERSION = '0.08';  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    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  It contains several assumptions:  =head1 FUNCTIONS
57    
58  =over  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  format of fields is defined using C<v123^a> notation for repeatable fields  Return data structure
 or C<s123^a> for single (or first) value, where C<123> is field number and  
 C<a> is subfield.  
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  source data records (C<$rec>) have unique identifiers in field C<000>  Options C<lookup>, C<row>, C<rules> and C<log> are mandatory while all
73    other are optional.
74    
75  =item *  This function will B<die> if normalizastion can't be evaled.
76    
77  optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be  Since this function isn't exported you have to call it with
78  perl code that is evaluated before producing output (value of field will be  C<WebPAC::Normalize::data_structure>.
 interpolated before that)  
79    
80  =item *  =cut
81    
82  optional C<filter{filter_name}> at B<begining of format> will apply perl  sub data_structure {
83  code defined as code ref on format after field substitution to producing          my $arg = {@_};
 output  
84    
85  There is one built-in filter called C<regex> which can be use like this:          die "need row argument" unless ($arg->{row});
86            die "need normalisation argument" unless ($arg->{rules});
87    
88    filter{regex(s/foo/bar/)}          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  =item *          return _get_ds();
96    }
97    
98  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.  =head2 _set_rec
99    
100  =item *  Set current record hash
101    
102  at end, optional C<format>s rules are resolved. Format rules are similar to    _set_rec( $rec );
 C<sprintf> and can also contain C<lookup{...}> which is performed after  
 values are inserted in format.  
103    
104  =back  =cut
105    
106  This also describes order in which transformations are applied (eval,  my $rec;
 filter, lookup, format) which is important to undestand when deciding how to  
 solve your data mungling and normalisation process.  
107    
108    sub _set_rec {
109            $rec = shift or die "no record hash";
110    }
111    
112    =head2 _get_ds
113    
114    Return hash formatted as data structure
115    
116  =head1 FUNCTIONS    my $ds = _get_ds();
117    
118  =head2 new  =cut
119    
120  Create new normalisation object  my ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators);
121    
122    my $n = new WebPAC::Normalize::Something(  sub _get_ds {
123          filter => {          return $out;
124                  'filter_name_1' => sub {  }
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
         db => $db_obj,  
         lookup_regex => $lookup->regex,  
         lookup => $lookup_obj,  
         prefix => 'foobar',  
   );  
125    
126  Parametar C<filter> defines user supplied snippets of perl code which can  =head2 _clean_ds
 be use with C<filter{...}> notation.  
127    
128  C<prefix> is used to form filename for database record (to support multiple  Clean data structure hash for next record
 source files which are joined in one database).  
129    
130  Recommended parametar C<lookup_regex> is used to enable parsing of lookups    _clean_ds();
 in structures. If you pass this parametar, you must also pass C<lookup>  
 which is C<WebPAC::Lookup> object.  
131    
132  =cut  =cut
133    
134  sub new {  sub _clean_ds {
135          my $class = shift;          my $a = {@_};
136          my $self = {@_};          ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators) = ();
137          bless($self, $class);          $marc_encoding = $a->{marc_encoding};
138    }
         my $r = $self->{'lookup_regex'} ? 1 : 0;  
         my $l = $self->{'lookup'} ? 1 : 0;  
   
         my $log = $self->_get_logger();  
139    
140          # those two must be in pair  =head2 _set_lookup
         if ( ($r & $l) != ($r || $l) ) {  
                 my $log = $self->_get_logger();  
                 $log->logdie("lookup_regex and lookup must be in pair");  
         }  
141    
142          $log->logdie("lookup must be WebPAC::Lookup object") if ($self->{'lookup'} && ! $self->{'lookup'}->isa('WebPAC::Lookup'));  Set current lookup hash
143    
144          $log->warn("no prefix defined. please check that!") unless ($self->{'prefix'});    _set_lookup( $lookup );
145    
146          $log->debug("using lookup regex: ", $self->{lookup_regex}) if ($r && $l);  =cut
147    
148          if (! $self->{filter} || ! $self->{filter}->{regex}) {  my $lookup;
                 $log->debug("adding built-in filter regex");  
                 $self->{filter}->{regex} = sub {  
                         my ($val, $regex) = @_;  
                         eval "\$val =~ $regex";  
                         return $val;  
                 };  
         }  
149    
150          $self ? return $self : return undef;  sub _set_lookup {
151            $lookup = shift;
152  }  }
153    
154    =head2 _get_marc_fields
155    
156  =head2 data_structure  Get all fields defined by calls to C<marc>
   
 Create in-memory data structure which represents normalized layout from  
 C<conf/normalize/*.xml>.  
   
 This structures are used to produce output.  
157    
158   my $ds = $webpac->data_structure($rec);          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
159    
160  =cut  We are using I<magic> which detect repeatable fields only from
161    sequence of field/subfield data generated by normalization.
162    
163  sub data_structure {  Repeatable field is created when there is second occurence of same subfield or
164          my $self = shift;  if any of indicators are different.
165    
166          my $log = $self->_get_logger();  This is sane for most cases. Something like:
167    
168          my $rec = shift;    900a-1 900b-1 900c-1
169          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    900a-2 900b-2
170      900a-3
171    
172          $log->debug("data_structure rec = ", sub { Dumper($rec) });  will be created from any combination of:
173    
174          $log->logdie("need unique ID (mfn) in field 000 of record " . Dumper($rec) ) unless (defined($rec->{'000'}));    900a-1 900a-2 900a-3 900b-1 900b-2 900c-1
175    
176          my $id = $rec->{'000'}->[0] || $log->logdie("field 000 isn't array!");  and following rules:
177    
178          my $cache_file;    marc('900','a', rec('200','a') );
179      marc('900','b', rec('200','b') );
180      marc('900','c', rec('200','c') );
181    
182          if ($self->{'db'}) {  which might not be what you have in mind. If you need repeatable subfield,
183                  my $ds = $self->{'db'}->load_ds( id => $id, prefix => $self->{prefix} );  define it using C<marc_repeatable_subfield> like this:
                 $log->debug("load_ds( rec = ", sub { Dumper($rec) }, ") = ", sub { Dumper($ds) });  
                 return $ds if ($ds);  
                 $log->debug("cache miss, creating");  
         }  
   
         my @sorted_tags;  
         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;  
         }  
184    
185          my $ds;  ....
186    
187          $log->debug("tags: ",sub { join(", ",@sorted_tags) });  =cut
188    
189          foreach my $field (@sorted_tags) {  sub _get_marc_fields {
190    
191                  my $row;          return if (! $marc_record || ref($marc_record) ne 'ARRAY' || $#{ $marc_record } < 0);
192    
193  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});          # first, sort all existing fields
194            # 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                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {          @sorted_marc_record = @{ $marc_record };        ### FIXME disable sorting
200                          my $format;          
201            # output marc fields
202            my @m;
203    
204                          $log->logdie("expected tag HASH and got $tag") unless (ref($tag) eq 'HASH');          # count unique field-subfields (used for offset when walking to next subfield)
205                          $format = $tag->{'value'} || $tag->{'content'};          my $u;
206            map { $u->{ $_->[0] . $_->[3]  }++ } @sorted_marc_record;
207    
208            if ($debug) {
209                    warn "## marc_repeatable_subfield ", dump( $marc_repeatable_subfield ), $/;
210                    warn "## marc_record ", dump( $marc_record ), $/;
211                    warn "## sorted_marc_record ", dump( \@sorted_marc_record ), $/;
212                    warn "## subfield count ", dump( $u ), $/;
213            }
214    
215                          my @v;          my $len = $#sorted_marc_record;
216                          if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {          my $visited;
217                                  @v = $self->fill_in_to_arr($rec,$format);          my $i = 0;
218                          } else {          my $field;
                                 @v = $self->parse_to_arr($rec,$format);  
                         }  
                         if (! @v) {  
                                 $log->debug("$field <",$self->{tag},"> format: $format no values");  
 #                               next;  
                         } else {  
                                 $log->debug("$field <",$self->{tag},"> format: $format values: ", join(",", @v));  
                         }  
219    
220                          if ($tag->{'sort'}) {          foreach ( 0 .. $len ) {
                                 @v = $self->sort_arr(@v);  
                         }  
221    
222                          # use format?                  # find next element which isn't visited
223                          if ($tag->{'format_name'}) {                  while ($visited->{$i}) {
224                                  @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;                          $i = ($i + 1) % ($len + 1);
225                          }                  }
226    
227                          # delimiter will join repeatable fields                  # mark it visited
228                          if ($tag->{'delimiter'}) {                  $visited->{$i}++;
                                 @v = ( join($tag->{'delimiter'}, @v) );  
                         }  
229    
230                          # default types                  my $row = $sorted_marc_record[$i];
                         my @types = qw(display search);  
                         # override by type attribute  
                         @types = ( $tag->{'type'} ) if ($tag->{'type'});  
   
                         foreach my $type (@types) {  
                                 # append to previous line?  
                                 $log->debug("tag $field / $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                          $ds->{$row_name} = $row;                          # insert first field
274                            $field = $row;
                         $log->debug("row $field: ",sub { Dumper($row) });  
275                  }                  }
276    
277                    if (! $marc_repeatable_subfield->{ $fsf }) {
278                            # make step to next subfield
279                            $i = ($i + $u->{ $fsf } ) % ($len + 1);
280                    }
281          }          }
282    
283          $self->{'db'}->save_ds(          if ($#$field >= 0) {
284                  id => $id,                  push @m, $field;
285                  ds => $ds,                  warn "## saved/3 ", dump( $field ),$/ if ($debug);
286                  prefix => $self->{prefix},          }
         ) if ($self->{'db'});  
   
         $log->debug("ds: ", sub { Dumper($ds) });  
   
         $log->logconfess("data structure returned is not array any more!") if wantarray;  
   
         return $ds;  
287    
288            return @m;
289  }  }
290    
291  =head2 parse  =head2 _debug
   
 Perform smart parsing of string, skipping delimiters for fields which aren't  
 defined. It can also eval code in format starting with C<eval{...}> and  
 return output or nothing depending on eval code.  
   
  my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);  
292    
293  Filters are implemented here. While simple form of filters looks like this:  Change level of debug warnings
294    
295    filter{name_of_filter}    _debug( 2 );
   
 but, filters can also have variable number of parametars like this:  
   
   filter{name_of_filter(param,param,param)}  
296    
297  =cut  =cut
298    
299  my $warn_once;  sub _debug {
300            my $l = shift;
301  sub parse {          return $debug unless defined($l);
302          my $self = shift;          warn "debug level $l",$/ if ($l > 0);
303            $debug = $l;
304          my ($rec, $format_utf8, $i, $rec_size) = @_;  }
305    
306          return if (! $format_utf8);  =head1 Functions to create C<data_structure>
307    
308          my $log = $self->_get_logger();  Those functions generally have to first in your normalization file.
309    
310          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  =head2 tag
311    
312          $i = 0 if (! $i);  Define new tag for I<search> and I<display>.
313    
314          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});    tag('Title', rec('200','a') );
315    
         my @out;  
316    
317          $log->debug("format: $format [$i]");  =cut
318    
319          my $eval_code;  sub tag {
320          # remove eval{...} from beginning          my $name = shift or die "tag needs name as first argument";
321          $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);          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 $filter_name;  =head2 display
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
329    
330          # did we found any (att all) field from format in row?  Define tag just for I<display>
         my $found_any;  
         # prefix before first field which we preserve it $found_any  
         my $prefix;  
331    
332          my $f_step = 1;    @v = display('Title', rec('200','a') );
333    
334          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  =cut
335    
336                  my $del = $1 || '';  sub display {
337                  $prefix = $del if ($f_step == 1);          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 $fld_type = lc($2);  =head2 search
345    
346                  # repeatable index  Prepare values just for I<search>
                 my $r = $i;  
                 if ($fld_type eq 's') {  
                         if ($found_any->{'v'}) {  
                                 $r = 0;  
                         } else {  
                                 return;  
                         }  
                 }  
347    
348                  my $found = 0;    @v = search('Title', rec('200','a') );
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found,$rec_size);  
349    
350                  if ($found) {  =cut
                         $found_any->{$fld_type} += $found;  
351    
352                          # we will skip delimiter before first occurence of field!  sub search {
353                          push @out, $del unless($found_any->{$fld_type} == 1);          my $name = shift or die "search needs name as first argument";
354                          push @out, $tmp;          my @o = grep { defined($_) && $_ ne '' } @_;
355                  }          return unless (@o);
356                  $f_step++;          $out->{$name}->{tag} = $name;
357          }          $out->{$name}->{search} = \@o;
358    }
359    
360          # test if any fields found?  =head2 marc_leader
         return if (! $found_any->{'v'} && ! $found_any->{'s'});  
361    
362          my $out = join('',@out);  Setup fields within MARC leader or get leader
363    
364          if ($out) {    marc_leader('05','c');
365                  # add rest of format (suffix)    my $leader = marc_leader();
                 $out .= $format;  
366    
367                  # add prefix if not there  =cut
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
368    
369                  $log->debug("result: $out");  sub marc_leader {
370          }          my ($offset,$value) = @_;
371    
372          if ($eval_code) {          if ($offset) {
373                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;                  $out->{' leader'}->{ $offset } = $value;
374                  $log->debug("about to eval{$eval} format: $out");          } else {
375                  return if (! $self->_eval($eval));                  return $out->{' leader'};
         }  
           
         if ($filter_name) {  
                 my @filter_args;  
                 if ($filter_name =~ s/(\w+)\((.*)\)/$1/) {  
                         @filter_args = split(/,/, $2);  
                 }  
                 if ($self->{'filter'}->{$filter_name}) {  
                         $log->debug("about to filter{$filter_name} format: $out with arguments: ", join(",", @filter_args));  
                         unshift @filter_args, $out;  
                         $out = $self->{'filter'}->{$filter_name}->(@filter_args);  
                         return unless(defined($out));  
                         $log->debug("filter result: $out");  
                 } elsif (! $warn_once->{$filter_name}) {  
                         $log->warn("trying to use undefined filter $filter_name");  
                         $warn_once->{$filter_name}++;  
                 }  
376          }          }
   
         return $out;  
377  }  }
378    
379  =head2 parse_to_arr  =head2 marc
380    
381  Similar to C<parse>, but returns array of all repeatable fields  Save value for MARC field
382    
383   my @arr = $webpac->parse_to_arr($rec,'v250^a');    marc('900','a', rec('200','a') );
384    
385  =cut  =cut
386    
387  sub parse_to_arr {  sub marc {
388          my $self = shift;          my $f = shift or die "marc needs field";
389            die "marc field must be numer" unless ($f =~ /^\d+$/);
         my ($rec, $format_utf8) = @_;  
390    
391          my $log = $self->_get_logger();          my $sf = shift or die "marc needs subfield";
392    
393          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);          foreach (@_) {
394          return if (! $format_utf8);                  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          my $i = 0;  =head2 marc_repeatable_subfield
         my @arr;  
403    
404          my $rec_size = { '_' => '_' };  Save values for MARC repetable subfield
405    
406          while (my $v = $self->parse($rec,$format_utf8,$i++,\$rec_size)) {    marc_repeatable_subfield('910', 'z', rec('909') );
                 push @arr, $v;  
                 warn "parse rec_size = ", Dumper($rec_size);  
         }  
407    
408          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  =cut
409    
410          return @arr;  sub marc_repeatable_subfield {
411            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    =head2 marc_indicators
418    
419  =head2 fill_in  Set both indicators for MARC field
420    
421  Workhourse of all: takes record from in-memory structure of database and    marc_indicators('900', ' ', 1);
 strings with placeholders and returns string or array of with substituted  
 values from record.  
422    
423   my $text = $webpac->fill_in($rec,'v250^a');  Any indicator value other than C<0-9> will be treated as undefined.
424    
425  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.  
426    
427   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  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  This function B<does not> perform parsing of format to inteligenty skip          $i1 = ' ' if ($i1 !~ /^\d$/);
434  delimiters before fields which aren't used.          $i2 = ' ' if ($i2 !~ /^\d$/);
435            @{ $marc_indicators->{$f} } = ($i1,$i2);
436    }
437    
438  This method will automatically decode UTF-8 string to local code page  =head2 marc_compose
 if needed.  
439    
440  There is optional parametar C<$record_size> which can be used to get sizes of  Save values for each MARC subfield explicitly
 all C<field^subfield> combinations in this format.  
441    
442   my $text = $webpac->fill_in($rec,'got: v900^a v900^x',0,\$rec_size);    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  =cut  =cut
450    
451  sub fill_in {  sub marc_compose {
452          my $self = shift;          my $f = shift or die "marc_compose needs field";
453            die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
454    
455          my $log = $self->_get_logger();          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
456            my $m = [ $f, $i1, $i2 ];
457    
458          my ($rec,$format,$i,$rec_size) = @_;          while (@_) {
459                    my $sf = shift or die "marc_compose $f needs subfield";
460                    my $v = shift;
461    
462          $log->logconfess("need data record") unless ($rec);                  next unless (defined($v) && $v !~ /^\s*$/);
463          $log->logconfess("need format to parse") unless($format);                  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          # iteration (for repeatable fields)          warn "## marc_compose(d) ", dump( $m ),$/ if ($debug > 1);
         $i ||= 0;  
469    
470          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));          push @{ $marc_record }, $m if ($#{$m} > 2);
471    }
472    
         # FIXME remove for speedup?  
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
473    
474          if (utf8::is_utf8($format)) {  =head1 Functions to extract data from input
                 $format = $self->_x($format);  
         }  
475    
476          my $found = 0;  This function should be used inside functions to create C<data_structure> described
477          my $just_single = 1;  above.
478    
479          my $eval_code;  =head2 rec1
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
480    
481          my $filter_name;  Return all values in some field
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
482    
483          # do actual replacement of placeholders    @v = rec1('200')
         # repeatable fields  
         if ($format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found,$rec_size)/ges) {  
                 $just_single = 0;  
         }  
484    
485          # non-repeatable fields  TODO: order of values is probably same as in source data, need to investigate that
         if ($format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found,$rec_size)/ges) {  
                 return if ($i > 0 && $just_single);  
         }  
486    
487          if ($found) {  =cut
488                  $log->debug("format: $format");  
489                  if ($eval_code) {  sub rec1 {
490                          my $eval = $self->fill_in($rec,$eval_code,$i);          my $f = shift;
491                          return if (! $self->_eval($eval));          return unless (defined($rec) && defined($rec->{$f}));
492                  }          if (ref($rec->{$f}) eq 'ARRAY') {
493                  if ($filter_name && $self->{'filter'}->{$filter_name}) {                  return map {
494                          $log->debug("filter '$filter_name' for $format");                          if (ref($_) eq 'HASH') {
495                          $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')) {  
                                 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
   
 Similar to C<fill_in>, but returns array of all repeatable fields. Usable  
 for fields which have lookups, so they shouldn't be parsed but rather  
 C<fill_id>ed.  
508    
509   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');    @v = rec2('200','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 ($rec, $format_utf8) = @_;          my $sf = shift;
517            return map { $_->{$sf} } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
518    }
519    
520          my $log = $self->_get_logger();  =head2 rec
521    
522          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  syntaxtic sugar for
         return if (! $format_utf8);  
523    
524          my $i = 0;    @v = rec('200')
525          my @arr;    @v = rec('200','a')
526    
527          my $rec_size;  =cut
528    
529          while (my $v = $self->fill_in($rec,$format_utf8,$i,\$rec_size)) {  sub rec {
530                  push @arr, $v;          if ($#_ == 0) {
531                  warn "rec_size = ", Dumper($rec_size);                  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.  
540    
541   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found,\$rec_size);    @v = regex( 's/foo/bar/g', @v );
542    
543  Required arguments are:  =cut
   
 =over 8  
   
 =item C<$rec>  
   
 record reference  
   
 =item C<$f>  
   
 field  
   
 =item C<$sf>  
544    
545  optional subfield  sub regex {
546            my $r = shift;
547            my @out;
548            #warn "r: $r\n", dump(\@_);
549            foreach my $t (@_) {
550                    next unless ($t);
551                    eval "\$t =~ $r";
552                    push @out, $t if ($t && $t ne '');
553            }
554            return @out;
555    }
556    
557  =item C<$i>  =head2 prefix
558    
559  index offset for repeatable values ( 0 ... $rec_size->{'400^a'} )  Prefix all values with a string
560    
561  =item C<$found>    @v = prefix( 'my_', @v );
562    
563  optional variable that will be incremeted if preset  =cut
564    
565  =item C<$rec_size>  sub prefix {
566            my $p = shift or die "prefix needs string as first argument";
567            return map { $p . $_ } grep { defined($_) } @_;
568    }
569    
570  hash to hold maximum occurances of C<field^subfield> combinations  =head2 suffix
 (which can be accessed using keys in same format)  
571    
572  =back  suffix all values with a string
573    
574  Returns value or empty string, updates C<$found> and C<rec_size>    @v = suffix( '_my', @v );
 if present.  
575    
576  =cut  =cut
577    
578  sub get_data {  sub suffix {
579          my $self = shift;          my $s = shift or die "suffix needs string as first argument";
580            return map { $_ . $s } grep { defined($_) } @_;
581    }
582    
583          my ($rec,$f,$sf,$i,$found,$cache) = @_;  =head2 surround
584    
585          return '' unless ($$rec->{$f} && ref($$rec->{$f}) eq 'ARRAY');  surround all values with a two strings
586    
587          if (defined($$cache)) {    @v = surround( 'prefix_', '_suffix', @v );
                 $$cache->{ $f . ( $sf ? '^' . $sf : '' ) } ||= scalar @{ $$rec->{$f} };  
         }  
588    
589          return '' unless ($$rec->{$f}->[$i]);  =cut
590    
591          {  sub surround {
592                  no strict 'refs';          my $p = shift or die "surround need prefix as first argument";
593                  if (defined($sf)) {          my $s = shift or die "surround needs suffix as second argument";
594                          $$found++ if (defined($$found) && $$rec->{$f}->[$i]->{$sf});          return map { $p . $_ . $s } grep { defined($_) } @_;
                         return $$rec->{$f}->[$i]->{$sf};  
                 } else {  
                         $$found++ if (defined($$found));  
                         # it still might have subfields, just  
                         # not specified, so we'll dump some debug info  
                         if ($$rec->{$f}->[$i] =~ /HASH/o) {  
                                 my $out;  
                                 foreach my $k (keys %{$$rec->{$f}->[$i]}) {  
                                         $out .= '$' . $k .':' . $$rec->{$f}->[$i]->{$k}." ";  
                                 }  
                                 return $out;  
                         } else {  
                                 return $$rec->{$f}->[$i];  
                         }  
                 }  
         }  
595  }  }
596    
597    =head2 first
598    
599  =head2 apply_format  Return first element
600    
601  Apply format specified in tag with C<format_name="name"> and    $v = first( @v );
 C<format_delimiter=";;">.  
   
  my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  
   
 Formats can contain C<lookup{...}> if you need them.  
602    
603  =cut  =cut
604    
605  sub apply_format {  sub first {
606          my $self = shift;          my $r = shift;
607            return $r;
608          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;  
         }  
609    
610          $log->warn("no delimiter for format $name") if (! $delimiter);  =head2 lookup
611    
612          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  Consult lookup hashes for some value
613    
614          my @data = split(/\Q$delimiter\E/, $data);    @v = lookup( $v );
615      @v = lookup( @v );
616    
617          my $out = sprintf($format, @data);  =cut
         $log->debug("using format $name [$format] on $data to produce: $out");  
618    
619          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {  sub lookup {
620                  return $self->{'lookup'}->lookup($out);          my $k = shift or return;
621            return unless (defined($lookup->{$k}));
622            if (ref($lookup->{$k}) eq 'ARRAY') {
623                    return @{ $lookup->{$k} };
624          } else {          } else {
625                  return $out;                  return $lookup->{$k};
626          }          }
   
627  }  }
628    
629  =head2 sort_arr  =head2 join_with
630    
631  Sort array ignoring case and html in data  Joins walues with some delimiter
632    
633   my @sorted = $webpac->sort_arr(@unsorted);    $v = join_with(", ", @v);
634    
635  =cut  =cut
636    
637  sub sort_arr {  sub join_with {
638          my $self = shift;          my $d = shift;
639            return join($d, grep { defined($_) && $_ ne '' } @_);
         my $log = $self->_get_logger();  
   
         # 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;  
640  }  }
641    
642    =head2 split_rec_on
643    
644  =head1 INTERNAL METHODS  Split record subfield on some regex and take one of parts out
   
 =head2 _sort_by_order  
   
 Sort xml tags data structure accoding to C<order=""> attribute.  
   
 =cut  
   
 sub _sort_by_order {  
         my $self = shift;  
   
         my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$a};  
         my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$b};  
   
         return $va <=> $vb;  
 }  
   
 =head2 _x  
645    
646  Convert strings from C<conf/normalize/*.xml> encoding into application    $a_before_semi_column =
647  specific encoding (optinally specified using C<code_page> to C<new>          split_rec_on('200','a', /\s*;\s*/, $part);
 constructor).  
648    
649   my $text = $n->_x('normalize text string');  C<$part> is optional number of element. First element is
650    B<1>, not 0!
651    
652  This is a stub so that other modules doesn't have to implement it.  If there is no C<$part> parameter or C<$part> is 0, this function will
653    return all values produced by splitting.
654    
655  =cut  =cut
656    
657  sub _x {  sub split_rec_on {
658          my $self = shift;          die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
         return shift;  
 }  
   
   
 =head1 AUTHOR  
659    
660  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>          my ($fld, $sf, $regex, $part) = @_;
661            warn "### regex ", ref($regex), $regex, $/ if ($debug > 2);
662    
663  =head1 COPYRIGHT & LICENSE          my @r = rec( $fld, $sf );
664            my $v = shift @r;
665            warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
666    
667  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.          return '' if( ! defined($v) || $v =~ /^\s*$/);
668    
669  This program is free software; you can redistribute it and/or modify it          my @s = split( $regex, $v );
670  under the same terms as Perl itself.          warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
671            if ($part && $part > 0) {
672  =cut                  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.371  
changed lines
  Added in v.568

  ViewVC Help
Powered by ViewVC 1.1.26