/[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 433 by dpavlin, Mon Apr 17 16:01:12 2006 UTC revision 565 by dpavlin, Sun Jul 2 20:33:13 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    
# Line 21  our $VERSION = '0.09'; Line 41  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  =over  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  =item *  =head1 FUNCTIONS
   
 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 *  
   
 source data records (C<$rec>) have unique identifiers in field C<000>  
   
 =item *  
57    
58  optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be  Functions which start with C<_> are private and used by WebPAC internally.
59  perl code that is evaluated before producing output (value of field will be  All other functions are available for use within normalisation rules.
 interpolated before that)  
60    
61  =item *  =head2 data_structure
62    
63  optional C<filter{filter_name}> at B<begining of format> will apply perl  Return data structure
 code defined as code ref on format after field substitution to producing  
 output  
64    
65  There is one built-in filter called C<regex> which can be use like this:    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    filter{regex(s/foo/bar/)}  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<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;  
   
         my $log = $self->_get_logger();  
121    
122          # those two must be in pair  sub _get_ds {
123          if ( ($r & $l) != ($r || $l) ) {          return $out;
124                  my $log = $self->_get_logger();  }
                 $log->logdie("lookup_regex and lookup must be in pair");  
         }  
125    
126          $log->logdie("lookup must be WebPAC::Lookup object") if ($self->{'lookup'} && ! $self->{'lookup'}->isa('WebPAC::Lookup'));  =head2 _clean_ds
127    
128          $log->warn("no prefix defined. please check that!") unless ($self->{'prefix'});  Clean data structure hash for next record
129    
130          $log->debug("using lookup regex: ", $self->{lookup_regex}) if ($r && $l);    _clean_ds();
131    
132          if (! $self->{filter} || ! $self->{filter}->{regex}) {  =cut
                 $log->debug("adding built-in filter regex");  
                 $self->{filter}->{regex} = sub {  
                         my ($val, $regex) = @_;  
                         eval "\$val =~ $regex";  
                         return $val;  
                 };  
         }  
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 all_tags  =head2 _set_lookup
141    
142  Returns all tags in document in specified order  Set current lookup hash
143    
144    my $sorted_tags = $self->all_tags();    _set_lookup( $lookup );
145    
146  =cut  =cut
147    
148  sub all_tags {  my $lookup;
         my $self = shift;  
149    
150          if (! $self->{_tags_by_order}) {  sub _set_lookup {
151            $lookup = shift;
152    }
153    
154                  my $log = $self->_get_logger;  =head2 _get_marc_fields
                 # sanity check  
                 $log->logdie("can't find self->{inport_xml}->{indexer}") unless ($self->{import_xml}->{indexer});  
155    
156                  my @tags = keys %{ $self->{'import_xml'}->{'indexer'}};  Get all fields defined by calls to C<marc>
                 $log->debug("unsorted tags: " . join(", ", @tags));  
157    
158                  @tags = sort { $self->_sort_by_order } @tags;          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
159    
160                  $log->debug("sorted tags: " . join(",", @tags) );  We are using I<magic> which detect repeatable fields only from
161    sequence of field/subfield data generated by normalization.
162    
163                  $self->{_tags_by_order} = \@tags;  Repeatable field is created when there is second occurence of same subfield or
164          }  if any of indicators are different.
165    
166          return $self->{_tags_by_order};  This is sane for most cases. Something like:
 }  
167    
168      900a-1 900b-1 900c-1
169      900a-2 900b-2
170      900a-3
171    
172    will be created from any combination of:
173    
174  =head2 data_structure    900a-1 900a-2 900a-3 900b-1 900b-2 900c-1
175    
176  Create in-memory data structure which represents normalized layout from  and following rules:
 C<conf/normalize/*.xml>.  
177    
178  This structures are used to produce output.    marc('900','a', rec('200','a') );
179      marc('900','b', rec('200','b') );
180      marc('900','c', rec('200','c') );
181    
182   my $ds = $webpac->data_structure($rec);  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  =cut  ....
186    
187  sub data_structure {  =cut
         my $self = shift;  
   
         my $log = $self->_get_logger();  
   
         my $rec = shift;  
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
188    
189          $log->debug("data_structure rec = ", sub { Dumper($rec) });  sub _get_marc_fields {
190    
191          $log->logdie("need unique ID (mfn) in field 000 of record " . Dumper($rec) ) unless (defined($rec->{'000'}));          return if (! $marc_record || ref($marc_record) ne 'ARRAY' || $#{ $marc_record } < 0);
192    
193          my $id = $rec->{'000'}->[0] || $log->logdie("field 000 isn't array!");          # 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          my $cache_file;          @sorted_marc_record = @{ $marc_record };        ### FIXME disable sorting
200            
201            # output marc fields
202            my @m;
203    
204          if ($self->{'db'}) {          # count unique field-subfields (used for offset when walking to next subfield)
205                  my $ds = $self->{'db'}->load_ds( id => $id, prefix => $self->{prefix} );          my $u;
206                  $log->debug("load_ds( rec = ", sub { Dumper($rec) }, ") = ", sub { Dumper($ds) });          map { $u->{ $_->[0] . $_->[3]  }++ } @sorted_marc_record;
207                  return $ds if ($ds);  
208                  $log->debug("cache miss, creating");          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 $tags = $self->all_tags();          my $len = $#sorted_marc_record;
216            my $visited;
217          $log->debug("tags: ",sub { join(", ",@{ $tags }) });          my $i = 0;
218            my $field;
         my $ds;  
   
         foreach my $field (@{ $tags }) {  
219    
220                  my $row;          foreach ( 0 .. $len ) {
221    
222  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});                  # find next element which isn't visited
223                    while ($visited->{$i}) {
224                            $i = ($i + 1) % ($len + 1);
225                    }
226    
227                    # mark it visited
228                    $visited->{$i}++;
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                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {                  }
                         my $format;  
245    
246                          $log->logdie("expected tag HASH and got $tag") unless (ref($tag) eq 'HASH');                  # if field exists
247                          $format = $tag->{'value'} || $tag->{'content'};                  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    
                         my @v;  
                         if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {  
                                 @v = $self->_rec_to_arr($rec,$format,'fill_in');  
268                          } else {                          } else {
269                                  @v = $self->_rec_to_arr($rec,$format,'parse');                                  # append new subfields to existing field
270                                    push @$field, ( $row->[3], $row->[4] );
271                          }                          }
272                          if (! @v) {                  } else {
273                                  $log->debug("$field <",$self->{tag},"> format: $format no values");                          # insert first field
274                                  next;                          $field = $row;
                         } else {  
                                 $log->debug("$field <",$self->{tag},"> format: $format values: ", join(",", @v));  
                         }  
   
                         if ($tag->{'sort'}) {  
                                 @v = $self->sort_arr(@v);  
                         }  
   
                         # use format?  
                         if ($tag->{'format_name'}) {  
                                 @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;  
                         }  
   
                         # delimiter will join repeatable fields  
                         if ($tag->{'delimiter'}) {  
                                 @v = ( join($tag->{'delimiter'}, @v) );  
                         }  
   
                         # default types  
                         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;  
                                 }  
                         }  
   
   
275                  }                  }
276    
277                  if ($row) {                  if (! $marc_repeatable_subfield->{ $fsf }) {
278                          $row->{'tag'} = $field;                          # make step to next subfield
279                            $i = ($i + $u->{ $fsf } ) % ($len + 1);
                         # TODO: name_sigular, name_plural  
                         my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};  
                         my $row_name = $name ? $self->_x($name) : $field;  
   
                         # post-sort all values in field  
                         if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {  
                                 $log->warn("sort at field tag not implemented");  
                         }  
   
                         $ds->{$row_name} = $row;  
   
                         $log->debug("row $field: ",sub { Dumper($row) });  
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,  }
                 ds => $ds,  
                 prefix => $self->{prefix},  
         ) if ($self->{'db'});  
290    
291          $log->debug("ds: ", sub { Dumper($ds) });  =head2 _debug
292    
293          $log->logconfess("data structure returned is not array any more!") if wantarray;  Change level of debug warnings
294    
295          return $ds;    _debug( 2 );
296    
297  }  =cut
298    
299  =head2 parse  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  Perform smart parsing of string, skipping delimiters for fields which aren't  =head1 Functions to create C<data_structure>
 defined. It can also eval code in format starting with C<eval{...}> and  
 return output or nothing depending on eval code.  
307    
308   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);  Those functions generally have to first in your normalization file.
309    
310  Filters are implemented here. While simple form of filters looks like this:  =head2 tag
311    
312    filter{name_of_filter}  Define new tag for I<search> and I<display>.
313    
314  but, filters can also have variable number of parametars like this:    tag('Title', rec('200','a') );
315    
   filter{name_of_filter(param,param,param)}  
316    
317  =cut  =cut
318    
319  my $warn_once;  sub tag {
320            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  sub parse {  =head2 display
         my $self = shift;  
329    
330          my ($rec, $format_utf8, $i, $rec_size) = @_;  Define tag just for I<display>
331    
332          return if (! $format_utf8);    @v = display('Title', rec('200','a') );
333    
334          my $log = $self->_get_logger();  =cut
335    
336          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  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          $i = 0 if (! $i);  =head2 search
345    
346          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  Prepare values just for I<search>
347    
348          my @out;    @v = search('Title', rec('200','a') );
349    
350          $log->debug("format: $format [$i]");  =cut
351    
352          my $eval_code;  sub search {
353          # remove eval{...} from beginning          my $name = shift or die "search needs name as first argument";
354          $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);          my @o = grep { defined($_) && $_ ne '' } @_;
355            return unless (@o);
356            $out->{$name}->{tag} = $name;
357            $out->{$name}->{search} = \@o;
358    }
359    
360          my $filter_name;  =head2 marc_leader
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
361    
362          # did we found any (att all) field from format in row?  Setup fields within MARC leader or get leader
         my $found_any;  
         # prefix before first field which we preserve it $found_any  
         my $prefix;  
363    
364          my $f_step = 1;    marc_leader('05','c');
365      my $leader = marc_leader();
366    
367          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  =cut
368    
369                  my $del = $1 || '';  sub marc_leader {
370                  $prefix = $del if ($f_step == 1);          my ($offset,$value) = @_;
371    
372                  my $fld_type = lc($2);          if ($offset) {
373                    $out->{' leader'}->{ $offset } = $value;
374            } else {
375                    return $out->{' leader'};
376            }
377    }
378    
379                  # repeatable index  =head2 marc
                 my $r = $i;  
                 if ($fld_type eq 's') {  
                         if ($found_any->{'v'}) {  
                                 $r = 0;  
                         } else {  
                                 return;  
                         }  
                 }  
380    
381                  my $found = 0;  Save value for MARC field
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found,$rec_size);  
382    
383                  if ($found) {    marc('900','a', rec('200','a') );
                         $found_any->{$fld_type} += $found;  
384    
385                          # we will skip delimiter before first occurence of field!  =cut
                         push @out, $del unless($found_any->{$fld_type} == 1);  
                         push @out, $tmp;  
                 }  
                 $f_step++;  
         }  
386    
387          # test if any fields found?  sub marc {
388          return if (! $found_any->{'v'} && ! $found_any->{'s'});          my $f = shift or die "marc needs field";
389            die "marc field must be numer" unless ($f =~ /^\d+$/);
390    
391          my $out = join('',@out);          my $sf = shift or die "marc needs subfield";
392    
393          if ($out) {          foreach (@_) {
394                  # add rest of format (suffix)                  my $v = $_;             # make var read-write for Encode
395                  $out .= $format;                  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                  # add prefix if not there  =head2 marc_repeatable_subfield
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
403    
404                  $log->debug("result: $out");  Save values for MARC repetable subfield
         }  
405    
406          if ($eval_code) {    marc_repeatable_subfield('910', 'z', rec('909') );
                 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) {  
                 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}++;  
                 }  
         }  
407    
408          return $out;  =cut
409    
410    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 fill_in  =head2 marc_indicators
418    
419  Workhourse of all: takes record from in-memory structure of database and  Set both indicators for MARC field
 strings with placeholders and returns string or array of with substituted  
 values from record.  
420    
421   my $text = $webpac->fill_in($rec,'v250^a');    marc_indicators('900', ' ', 1);
422    
423  Optional argument is ordinal number for repeatable fields. By default,  Any indicator value other than C<0-9> will be treated as undefined.
 it's assume to be first repeatable field (fields are perl array, so first  
 element is 0).  
 Following example will read second value from repeatable field.  
424    
425   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  =cut
426    
427  This function B<does not> perform parsing of format to inteligenty skip  sub marc_indicators {
428  delimiters before fields which aren't used.          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 method will automatically decode UTF-8 string to local code page          $i1 = ' ' if ($i1 !~ /^\d$/);
434  if needed.          $i2 = ' ' if ($i2 !~ /^\d$/);
435            @{ $marc_indicators->{$f} } = ($i1,$i2);
436    }
437    
438  There is optional parametar C<$record_size> which can be used to get sizes of  =head2 marc_compose
 all C<field^subfield> combinations in this format.  
439    
440   my $text = $webpac->fill_in($rec,'got: v900^a v900^x',0,\$rec_size);  Save values for each MARC subfield explicitly
441    
442      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          {    @v = rec1('200')
                 # fix warnings  
                 no warnings 'uninitialized';  
484    
485                  # do actual replacement of placeholders  TODO: order of values is probably same as in source data, need to investigate that
                 # repeatable fields  
                 if ($format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found,$rec_size)/ges) {  
                         $just_single = 0;  
                 }  
486    
487                  # non-repeatable fields  =cut
                 if ($format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found,$rec_size)/ges) {  
                         return if ($i > 0 && $just_single);  
                 }  
         }  
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 _rec_to_arr  Return all values in specific field and subfield
   
 Similar to C<parse> and 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<paste>d or C<fill_id>ed. Last argument is name of operation: C<paste> or C<fill_in>.  
508    
509   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]','paste');    @v = rec2('200','a')
510    
511  =cut  =cut
512    
513  sub _rec_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, $code) = @_;  =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          $log->debug("using $code on $format_utf8");  =cut
528    
529          my $i = 0;  sub rec {
530          my $max = 0;          if ($#_ == 0) {
531          my @arr;                  return rec1(@_);
532          my $rec_size = {};          } elsif ($#_ == 1) {
533                    return rec2(@_);
         while ($i <= $max) {  
                 my @v = $self->$code($rec,$format_utf8,$i++,\$rec_size);  
                 if ($rec_size) {  
                         foreach my $f (keys %{ $rec_size }) {  
                                 $max = $rec_size->{$f} if ($rec_size->{$f} > $max);  
                         }  
                         $log->debug("max set to $max");  
                         undef $rec_size;  
                 }  
                 if (@v) {  
                         push @arr, @v;  
                 } else {  
                         push @arr, '' if ($max > $i);  
                 }  
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
540    
541  Returns value from record.    @v = regex( 's/foo/bar/g', @v );
542    
543   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found,\$rec_size);  =cut
   
 Required arguments are:  
   
 =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;  
 }  
645    
646  =head2 _x    $a_before_semi_column =
647            split_rec_on('200','a', /\s*;\s*/, $part);
648    
649  Convert strings from C<conf/normalize/*.xml> encoding into application  C<$part> is optional number of element. First element is
650  specific encoding (optinally specified using C<code_page> to C<new>  B<1>, not 0!
 constructor).  
651    
652   my $text = $n->_x('normalize text string');  If there is no C<$part> parameter or C<$part> is 0, this function will
653    return all values produced by splitting.
 This is a stub so that other modules doesn't have to implement it.  
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  
   
 Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  
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          my @s = split( $regex, $v );
668  under the same terms as Perl itself.          warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s) if ($debug > 1);
669            if ($part > 0) {
670  =cut                  return $s[ $part - 1 ];
671            } else {
672                    return @s;
673            }
674    }
675    
676  1; # End of WebPAC::Normalize  # END
677    1;

Legend:
Removed from v.433  
changed lines
  Added in v.565

  ViewVC Help
Powered by ViewVC 1.1.26