/[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 15 by dpavlin, Sun Jul 17 10:42:23 2005 UTC revision 571 by dpavlin, Mon Jul 3 14:30:22 2006 UTC
# Line 1  Line 1 
1  package WebPAC::Normalize;  package WebPAC::Normalize;
2    use Exporter 'import';
3    @EXPORT = qw/
4            _set_rec _set_lookup
5            _get_ds _clean_ds
6            _debug
7    
8            tag search display
9            marc marc_indicators marc_repeatable_subfield
10            marc_compose marc_leader
11    
12            rec1 rec2 rec
13            regex prefix suffix surround
14            first lookup join_with
15    
16            split_rec_on
17    /;
18    
19  use warnings;  use warnings;
20  use strict;  use strict;
21  use Data::Dumper;  
22  use Storable;  #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.01  Version 0.09
37    
38  =cut  =cut
39    
40  our $VERSION = '0.01';  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  =item *          die "need row argument" unless ($arg->{row});
86            die "need normalisation argument" unless ($arg->{rules});
87    
88  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.          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  at end, optional C<format>s rules are resolved. Format rules are similar to  =head2 _set_rec
 C<sprintf> and can also contain C<lookup{...}> which is performed after  
 values are inserted in format.  
99    
100  =back  Set current record hash
101    
102  This also describes order in which transformations are applied (eval,    _set_rec( $rec );
 filter, lookup, format) which is important to undestand when deciding how to  
 solve your data mungling and normalisation process.  
103    
104    =cut
105    
106    my $rec;
107    
108    sub _set_rec {
109            $rec = shift or die "no record hash";
110    }
111    
112  =head1 FUNCTIONS  =head2 _get_ds
113    
114  =head2 new  Return hash formatted as data structure
115    
116  Create new normalisation object    my $ds = _get_ds();
117    
118    my $n = new WebPAC::Normalize::Something(  =cut
         filter => {  
                 'filter_name_1' => sub {  
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
         cache_data_structure => './cache/ds/',  
         lookup_regex => $lookup->regex,  
   );  
119    
120  Parametar C<filter> defines user supplied snippets of perl code which can  my ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators);
 be use with C<filter{...}> notation.  
121    
122  Optional parameter C<cache_data_structure> defines path to directory  sub _get_ds {
123  in which cache file for C<data_structure> call will be created.          return $out;
124    }
125    
126  Recommended parametar C<lookup_regex> is used to enable parsing of lookups  =head2 _clean_ds
 in structures.  
127    
128  =cut  Clean data structure hash for next record
129    
130  sub new {    _clean_ds();
         my $class = shift;  
         my $self = {@_};  
         bless($self, $class);  
131    
132          $self->setup_cache_dir( $self->{'cache_data_structure'} );  =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 setup_cache_dir  =head2 _set_lookup
141    
142  Check if specified cache directory exist, and if not, disable caching.  Set current lookup hash
143    
144   $setup_cache_dir('./cache/ds/');    _set_lookup( $lookup );
   
 If you pass false or zero value to this function, it will disable  
 cacheing.  
145    
146  =cut  =cut
147    
148  sub setup_cache_dir {  my $lookup;
         my $self = shift;  
   
         my $dir = shift;  
   
         my $log = $self->_get_logger();  
   
         if ($dir) {  
                 my $msg;  
                 if (! -e $dir) {  
                         $msg = "doesn't exist";  
                 } elsif (! -d $dir) {  
                         $msg = "is not directory";  
                 } elsif (! -w $dir) {  
                         $msg = "not writable";  
                 }  
149    
150                  if ($msg) {  sub _set_lookup {
151                          undef $self->{'cache_data_structure'};          $lookup = shift;
                         $log->warn("cache_data_structure $dir $msg, disabling...");  
                 } else {  
                         $log->debug("using cache dir $dir");  
                 }  
         } else {  
                 $log->debug("disabling cache");  
                 undef $self->{'cache_data_structure'};  
         }  
152  }  }
153    
154    =head2 _get_marc_fields
155    
156  =head2 data_structure  Get all fields defined by calls to C<marc>
157    
158  Create in-memory data structure which represents normalized layout from          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
 C<conf/normalize/*.xml>.  
159    
160  This structures are used to produce output.  We are using I<magic> which detect repeatable fields only from
161    sequence of field/subfield data generated by normalization.
162    
163   my @ds = $webpac->data_structure($rec);  Repeatable field is created when there is second occurence of same subfield or
164    if any of indicators are different.
165    
166  B<Note: historical oddity follows>  This is sane for most cases. Something like:
167    
168  This method will also set C<< $webpac->{'currnet_filename'} >> if there is    900a-1 900b-1 900c-1
169  C<< <filename> >> tag and C<< $webpac->{'headline'} >> if there is    900a-2 900b-2
170  C<< <headline> >> tag.    900a-3
171    
172  =cut  will be created from any combination of:
173    
174  sub data_structure {    900a-1 900a-2 900a-3 900b-1 900b-2 900c-1
         my $self = shift;  
175    
176          my $log = $self->_get_logger();  and following rules:
177    
178          my $rec = shift;    marc('900','a', rec('200','a') );
179          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    marc('900','b', rec('200','b') );
180      marc('900','c', rec('200','c') );
181    
182          my $cache_file;  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          if (my $cache_path = $self->{'cache_data_structure'}) {  ....
                 my $id = $rec->{'000'};  
                 $id = $rec->{'000'}->[0] if ($id =~ m/^ARRAY/o);  
                 unless (defined($id)) {  
                         $log->warn("Can't use cache_data_structure on records without unique identifier in field 000");  
                         undef $self->{'cache_data_structure'};  
                 } else {  
                         $cache_file = "$cache_path/$id";  
                         if (-r $cache_file) {  
                                 my $ds_ref = retrieve($cache_file);  
                                 if ($ds_ref) {  
                                         $log->debug("cache hit: $cache_file");  
                                         my $ok = 1;  
                                         foreach my $f (qw(current_filename headline)) {  
                                                 if ($ds_ref->{$f}) {  
                                                         $self->{$f} = $ds_ref->{$f};  
                                                 } else {  
                                                         $ok = 0;  
                                                 }  
                                         };  
                                         if ($ok && $ds_ref->{'ds'}) {  
                                                 return @{ $ds_ref->{'ds'} };  
                                         } else {  
                                                 $log->warn("cache_data_structure $cache_path corrupt. Use rm $cache_path/* to re-create it on next run!");  
                                                 undef $self->{'cache_data_structure'};  
                                         }  
                                 }  
                         }  
                 }  
         }  
186    
187          undef $self->{'currnet_filename'};  =cut
         undef $self->{'headline'};  
   
         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;  
         }  
   
         my @ds;  
   
         $log->debug("tags: ",sub { join(", ",@sorted_tags) });  
   
         foreach my $field (@sorted_tags) {  
188    
189                  my $row;  sub _get_marc_fields {
190    
191  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});          return if (! $marc_record || ref($marc_record) ne 'ARRAY' || $#{ $marc_record } < 0);
192    
193                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {          # first, sort all existing fields
194                          my $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                          if ($field eq 'filename') {                  # find next element which isn't visited
223                                  $self->{'current_filename'} = join('',@v);                  while ($visited->{$i}) {
224                                  $log->debug("filename: ",$self->{'current_filename'});                          $i = ($i + 1) % ($len + 1);
225                          } elsif ($field eq 'headline') {                  }
                                 $self->{'headline'} .= join('',@v);  
                                 $log->debug("headline: ",$self->{'headline'});  
                                 next; # don't return headline in data_structure!  
                         }  
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 swish);  
                         # override by type attribute  
                         @types = ( $tag->{'type'} ) if ($tag->{'type'});  
   
                         foreach my $type (@types) {  
                                 # append to previous line?  
                                 $log->debug("type: $type ",sub { join(" ",@v) }, $row->{'append'} || 'no append');  
                                 if ($tag->{'append'}) {  
   
                                         # I will delimit appended part with  
                                         # delimiter (or ,)  
                                         my $d = $tag->{'delimiter'};  
                                         # default delimiter  
                                         $d ||= " ";  
   
                                         my $last = pop @{$row->{$type}};  
                                         $d = "" if (! $last);  
                                         $last .= $d . join($d, @v);  
                                         push @{$row->{$type}}, $last;  
   
                                 } else {  
                                         push @{$row->{$type}}, @v;  
                                 }  
                         }  
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                          $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                          push @ds, $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          if ($cache_file) {          if ($#$field >= 0) {
284                  store {                  push @m, $field;
285                          ds => \@ds,                  warn "## saved/3 ", dump( $field ),$/ if ($debug);
                         current_filename => $self->{'current_filename'},  
                         headline => $self->{'headline'},  
                 }, $cache_file;  
                 $log->debug("created storable cache file $cache_file");  
286          }          }
287    
288          return @ds;          return @m;
   
289  }  }
290    
291  =head2 parse  =head2 _debug
292    
293  Perform smart parsing of string, skipping delimiters for fields which aren't  Change level of debug warnings
 defined. It can also eval code in format starting with C<eval{...}> and  
 return output or nothing depending on eval code.  
294    
295   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);    _debug( 2 );
296    
297  =cut  =cut
298    
299  sub parse {  sub _debug {
300          my $self = shift;          my $l = shift;
301            return $debug unless defined($l);
302            warn "debug level $l",$/ if ($l > 0);
303            $debug = $l;
304    }
305    
306          my ($rec, $format_utf8, $i) = @_;  =head1 Functions to create C<data_structure>
307    
308          return if (! $format_utf8);  Those functions generally have to first in your normalization file.
309    
310          my $log = $self->_get_logger();  =head2 tag
311    
312          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  Define new tag for I<search> and I<display>.
313    
314          $i = 0 if (! $i);    tag('Title', rec('200','a') );
315    
         my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  
316    
317          my @out;  =cut
318    
319          $log->debug("format: $format");  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          my $eval_code;  =head2 display
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
329    
330          my $filter_name;  Define tag just for I<display>
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
331    
332          my $prefix;    @v = display('Title', rec('200','a') );
         my $all_found=0;  
333    
334          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  =cut
335    
336                  my $del = $1 || '';  sub display {
337                  $prefix ||= $del if ($all_found == 0);          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                  # repeatable index  =head2 search
                 my $r = $i;  
                 $r = 0 if (lc("$2") eq 's');  
345    
346                  my $found = 0;  Prepare values just for I<search>
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);  
347    
348                  if ($found) {    @v = search('Title', rec('200','a') );
                         push @out, $del;  
                         push @out, $tmp;  
                         $all_found += $found;  
                 }  
         }  
349    
350          return if (! $all_found);  =cut
351    
352          my $out = join('',@out);  sub search {
353            my $name = shift or die "search needs name as first argument";
354            my @o = grep { defined($_) && $_ ne '' } @_;
355            return unless (@o);
356            $out->{$name}->{tag} = $name;
357            $out->{$name}->{search} = \@o;
358    }
359    
360          if ($out) {  =head2 marc_leader
                 # add rest of format (suffix)  
                 $out .= $format;  
361    
362                  # add prefix if not there  Setup fields within MARC leader or get leader
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
363    
364                  $log->debug("result: $out");    marc_leader('05','c');
365          }    my $leader = marc_leader();
366    
367          if ($eval_code) {  =cut
                 my $eval = $self->fill_in($rec,$eval_code,$i) || return;  
                 $log->debug("about to eval{$eval} format: $out");  
                 return if (! $self->_eval($eval));  
         }  
           
         if ($filter_name && $self->{'filter'}->{$filter_name}) {  
                 $log->debug("about to filter{$filter_name} format: $out");  
                 $out = $self->{'filter'}->{$filter_name}->($out);  
                 return unless(defined($out));  
                 $log->debug("filter result: $out");  
         }  
368    
369          return $out;  sub marc_leader {
370            my ($offset,$value) = @_;
371    
372            if ($offset) {
373                    $out->{' leader'}->{ $offset } = $value;
374            } else {
375                    return $out->{' leader'};
376            }
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      marc('001', rec('000') );
385    
386  =cut  =cut
387    
388  sub parse_to_arr {  sub marc {
389          my $self = shift;          my $f = shift or die "marc needs field";
390            die "marc field must be numer" unless ($f =~ /^\d+$/);
391    
392          my ($rec, $format_utf8) = @_;          my $sf;
393            if ($f >= 10) {
394                    $sf = shift or die "marc needs subfield";
395            }
396    
397          my $log = $self->_get_logger();          foreach (@_) {
398                    my $v = $_;             # make var read-write for Encode
399                    next unless (defined($v) && $v !~ /^\s*$/);
400                    from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
401                    my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
402                    if (defined $sf) {
403                            push @{ $marc_record }, [ $f, $i1, $i2, $sf => $v ];
404                    } else {
405                            push @{ $marc_record }, [ $f, $v ];
406                    }
407            }
408    }
409    
410          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  =head2 marc_repeatable_subfield
         return if (! $format_utf8);  
411    
412          my $i = 0;  Save values for MARC repetable subfield
         my @arr;  
413    
414          while (my $v = $self->parse($rec,$format_utf8,$i++)) {    marc_repeatable_subfield('910', 'z', rec('909') );
                 push @arr, $v;  
         }  
415    
416          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  =cut
417    
418          return @arr;  sub marc_repeatable_subfield {
419            my ($f,$sf) = @_;
420            die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);
421            $marc_repeatable_subfield->{ $f . $sf }++;
422            marc(@_);
423  }  }
424    
425    =head2 marc_indicators
426    
427  =head2 fill_in  Set both indicators for MARC field
428    
429  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.  
430    
431   my $text = $webpac->fill_in($rec,'v250^a');  Any indicator value other than C<0-9> will be treated as undefined.
432    
433  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.  
434    
435   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  sub marc_indicators {
436            my $f = shift || die "marc_indicators need field!\n";
437            my ($i1,$i2) = @_;
438            die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));
439            die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));
440    
441  This function B<does not> perform parsing of format to inteligenty skip          $i1 = ' ' if ($i1 !~ /^\d$/);
442  delimiters before fields which aren't used.          $i2 = ' ' if ($i2 !~ /^\d$/);
443            @{ $marc_indicators->{$f} } = ($i1,$i2);
444    }
445    
446  This method will automatically decode UTF-8 string to local code page  =head2 marc_compose
 if needed.  
447    
448  =cut  Save values for each MARC subfield explicitly
449    
450  sub fill_in {    marc_compose('900',
451          my $self = shift;          'a', rec('200','a')
452            'b', rec('201','a')
453            'a', rec('200','b')
454            'c', rec('200','c')
455      );
456    
457          my $log = $self->_get_logger();  =cut
458    
459          my $rec = shift || $log->logconfess("need data record");  sub marc_compose {
460          my $format = shift || $log->logconfess("need format to parse");          my $f = shift or die "marc_compose needs field";
461          # iteration (for repeatable fields)          die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
         my $i = shift || 0;  
462    
463          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
464            my $m = [ $f, $i1, $i2 ];
465    
466          # FIXME remove for speedup?          while (@_) {
467          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);                  my $sf = shift or die "marc_compose $f needs subfield";
468                    my $v = shift;
469    
470          if (utf8::is_utf8($format)) {                  next unless (defined($v) && $v !~ /^\s*$/);
471                  $format = $self->_x($format);                  from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
472                    push @$m, ( $sf, $v );
473                    warn "## ++ marc_compose($f,$sf,$v) ", dump( $m ),$/ if ($debug > 1);
474          }          }
475    
476          my $found = 0;          warn "## marc_compose(d) ", dump( $m ),$/ if ($debug > 1);
477    
478          my $eval_code;          push @{ $marc_record }, $m if ($#{$m} > 2);
479          # remove eval{...} from beginning  }
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
480    
         my $filter_name;  
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
481    
482          # do actual replacement of placeholders  =head1 Functions to extract data from input
         # 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;  
483    
484          if ($found) {  This function should be used inside functions to create C<data_structure> described
485                  $log->debug("format: $format");  above.
                 if ($eval_code) {  
                         my $eval = $self->fill_in($rec,$eval_code,$i);  
                         return if (! $self->_eval($eval));  
                 }  
                 if ($filter_name && $self->{'filter'}->{$filter_name}) {  
                         $log->debug("filter '$filter_name' for $format");  
                         $format = $self->{'filter'}->{$filter_name}->($format);  
                         return unless(defined($format));  
                         $log->debug("filter result: $format");  
                 }  
                 # do we have lookups?  
                 if ($self->{'lookup'}) {  
                         return $self->lookup($format);  
                 } else {  
                         return $format;  
                 }  
         } else {  
                 return;  
         }  
 }  
486    
487    =head2 rec1
488    
489  =head2 fill_in_to_arr  Return all values in some field
490    
491  Similar to C<fill_in>, but returns array of all repeatable fields. Usable    @v = rec1('200')
 for fields which have lookups, so they shouldn't be parsed but rather  
 C<fill_id>ed.  
492    
493   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');  TODO: order of values is probably same as in source data, need to investigate that
494    
495  =cut  =cut
496    
497  sub fill_in_to_arr {  sub rec1 {
498          my $self = shift;          my $f = shift;
499            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
500          my ($rec, $format_utf8) = @_;          return unless (defined($rec) && defined($rec->{$f}));
501            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
502          my $log = $self->_get_logger();          if (ref($rec->{$f}) eq 'ARRAY') {
503                    return map {
504                            if (ref($_) eq 'HASH') {
505                                    values %{$_};
506                            } else {
507                                    $_;
508                            }
509                    } @{ $rec->{$f} };
510            } elsif( defined($rec->{$f}) ) {
511                    return $rec->{$f};
512            }
513    }
514    
515          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  =head2 rec2
         return if (! $format_utf8);  
516    
517          my $i = 0;  Return all values in specific field and subfield
         my @arr;  
518    
519          while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {    @v = rec2('200','a')
                 push @arr, @v;  
         }  
520    
521          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  =cut
522    
523          return @arr;  sub rec2 {
524            my $f = shift;
525            return unless (defined($rec && $rec->{$f}));
526            my $sf = shift;
527            return map { $_->{$sf} } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
528  }  }
529    
530    =head2 rec
531    
532  =head2 get_data  syntaxtic sugar for
533    
534  Returns value from record.    @v = rec('200')
535      @v = rec('200','a')
536    
537   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);  =cut
   
 Arguments are:  
 record reference C<$rec>,  
 field C<$f>,  
 optional subfiled C<$sf>,  
 index for repeatable values C<$i>.  
538    
539  Optinal variable C<$found> will be incremeted if there  sub rec {
540  is field.          if ($#_ == 0) {
541                    return rec1(@_);
542            } elsif ($#_ == 1) {
543                    return rec2(@_);
544            }
545    }
546    
547  Returns value or empty string.  =head2 regex
548    
549  =cut  Apply regex to some or all values
550    
551  sub get_data {    @v = regex( 's/foo/bar/g', @v );
         my $self = shift;  
552    
553          my ($rec,$f,$sf,$i,$found) = @_;  =cut
554    
555          if ($$rec->{$f}) {  sub regex {
556                  return '' if (! $$rec->{$f}->[$i]);          my $r = shift;
557                  no strict 'refs';          my @out;
558                  if ($sf && $$rec->{$f}->[$i]->{$sf}) {          #warn "r: $r\n", dump(\@_);
559                          $$found++ if (defined($$found));          foreach my $t (@_) {
560                          return $$rec->{$f}->[$i]->{$sf};                  next unless ($t);
561                  } elsif ($$rec->{$f}->[$i]) {                  eval "\$t =~ $r";
562                          $$found++ if (defined($$found));                  push @out, $t if ($t && $t ne '');
                         # 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 '';  
563          }          }
564            return @out;
565  }  }
566    
567    =head2 prefix
568    
569  =head2 apply_format  Prefix all values with a string
570    
571  Apply format specified in tag with C<format_name="name"> and    @v = prefix( 'my_', @v );
 C<format_delimiter=";;">.  
   
  my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  
   
 Formats can contain C<lookup{...}> if you need them.  
572    
573  =cut  =cut
574    
575  sub apply_format {  sub prefix {
576          my $self = shift;          my $p = shift or die "prefix needs string as first argument";
577            return map { $p . $_ } grep { defined($_) } @_;
578    }
579    
580          my ($name,$delimiter,$data) = @_;  =head2 suffix
581    
582          my $log = $self->_get_logger();  suffix all values with a string
583    
584          if (! $self->{'import_xml'}->{'format'}->{$name}) {    @v = suffix( '_my', @v );
                 $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});  
                 return $data;  
         }  
585    
586          $log->warn("no delimiter for format $name") if (! $delimiter);  =cut
587    
588          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  sub suffix {
589            my $s = shift or die "suffix needs string as first argument";
590            return map { $_ . $s } grep { defined($_) } @_;
591    }
592    
593          my @data = split(/\Q$delimiter\E/, $data);  =head2 surround
594    
595          my $out = sprintf($format, @data);  surround all values with a two strings
         $log->debug("using format $name [$format] on $data to produce: $out");  
596    
597          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {    @v = surround( 'prefix_', '_suffix', @v );
598                  return $self->lookup($out);  
599          } else {  =cut
                 return $out;  
         }  
600    
601    sub surround {
602            my $p = shift or die "surround need prefix as first argument";
603            my $s = shift or die "surround needs suffix as second argument";
604            return map { $p . $_ . $s } grep { defined($_) } @_;
605  }  }
606    
607  =head2 sort_arr  =head2 first
608    
609  Sort array ignoring case and html in data  Return first element
610    
611   my @sorted = $webpac->sort_arr(@unsorted);    $v = first( @v );
612    
613  =cut  =cut
614    
615  sub sort_arr {  sub first {
616          my $self = shift;          my $r = shift;
617            return $r;
618    }
619    
620          my $log = $self->_get_logger();  =head2 lookup
621    
622          # FIXME add Schwartzian Transformation?  Consult lookup hashes for some value
623    
624          my @sorted = sort {    @v = lookup( $v );
625                  $a =~ s#<[^>]+/*>##;    @v = lookup( @v );
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
626    
627          return @sorted;  =cut
 }  
628    
629    sub lookup {
630            my $k = shift or return;
631            return unless (defined($lookup->{$k}));
632            if (ref($lookup->{$k}) eq 'ARRAY') {
633                    return @{ $lookup->{$k} };
634            } else {
635                    return $lookup->{$k};
636            }
637    }
638    
639  =head1 INTERNAL METHODS  =head2 join_with
640    
641  =head2 _sort_by_order  Joins walues with some delimiter
642    
643  Sort xml tags data structure accoding to C<order=""> attribute.    $v = join_with(", ", @v);
644    
645  =cut  =cut
646    
647  sub _sort_by_order {  sub join_with {
648          my $self = shift;          my $d = shift;
649            return join($d, grep { defined($_) && $_ ne '' } @_);
         my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$a};  
         my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$b};  
   
         return $va <=> $vb;  
650  }  }
651    
652  =head2 _x  =head2 split_rec_on
653    
654  Convert strings from C<conf/normalize/*.xml> encoding into application  Split record subfield on some regex and take one of parts out
 specific encoding (optinally specified using C<code_page> to C<new>  
 constructor).  
655    
656   my $text = $n->_x('normalize text string');    $a_before_semi_column =
657            split_rec_on('200','a', /\s*;\s*/, $part);
658    
659  This is a stub so that other modules doesn't have to implement it.  C<$part> is optional number of element. First element is
660    B<1>, not 0!
661    
662  =cut  If there is no C<$part> parameter or C<$part> is 0, this function will
663    return all values produced by splitting.
 sub _x {  
         my $self = shift;  
         return shift;  
 }  
664    
665    =cut
666    
667  =head1 AUTHOR  sub split_rec_on {
668            die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
 Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  
669    
670  =head1 COPYRIGHT & LICENSE          my ($fld, $sf, $regex, $part) = @_;
671            warn "### regex ", ref($regex), $regex, $/ if ($debug > 2);
672    
673  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.          my @r = rec( $fld, $sf );
674            my $v = shift @r;
675            warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
676    
677  This program is free software; you can redistribute it and/or modify it          return '' if( ! defined($v) || $v =~ /^\s*$/);
 under the same terms as Perl itself.  
678    
679  =cut          my @s = split( $regex, $v );
680            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
681            if ($part && $part > 0) {
682                    return $s[ $part - 1 ];
683            } else {
684                    return @s;
685            }
686    }
687    
688  1; # End of WebPAC::DB  # END
689    1;

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

  ViewVC Help
Powered by ViewVC 1.1.26