/[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 601 by dpavlin, Sun Jul 23 17:33:11 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            marc_duplicate marc_remove
12    
13            rec1 rec2 rec
14            regex prefix suffix surround
15            first lookup join_with
16    
17            split_rec_on
18    /;
19    
20  use warnings;  use warnings;
21  use strict;  use strict;
22  use Data::Dumper;  
23  use Storable;  #use base qw/WebPAC::Common/;
24    use Data::Dump qw/dump/;
25    use Encode qw/from_to/;
26    use Storable qw/dclone/;
27    
28    # debugging warn(s)
29    my $debug = 0;
30    
31    
32  =head1 NAME  =head1 NAME
33    
34  WebPAC::Normalize - data mungling for normalisation  WebPAC::Normalize - describe normalisaton rules using sets
35    
36  =head1 VERSION  =head1 VERSION
37    
38  Version 0.01  Version 0.14
39    
40  =cut  =cut
41    
42  our $VERSION = '0.01';  our $VERSION = '0.14';
43    
44  =head1 SYNOPSIS  =head1 SYNOPSIS
45    
46  This package contains code that mungle data to produce normalized format.  This module uses C<conf/normalize/*.pl> files to perform normalisation
47    from input records using perl functions which are specialized for set
48    processing.
49    
50    Sets are implemented as arrays, and normalisation file is valid perl, which
51    means that you check it's validity before running WebPAC using
52    C<perl -c normalize.pl>.
53    
54    Normalisation can generate multiple output normalized data. For now, supported output
55    types (on the left side of definition) are: C<tag>, C<display>, C<search> and
56    C<marc>.
57    
58  It contains several assumptions:  =head1 FUNCTIONS
59    
60  =over  Functions which start with C<_> are private and used by WebPAC internally.
61    All other functions are available for use within normalisation rules.
62    
63  =item *  =head2 data_structure
64    
65  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.  
66    
67  =item *    my $ds = WebPAC::Normalize::data_structure(
68            lookup => $lookup->lookup_hash,
69            row => $row,
70            rules => $normalize_pl_config,
71            marc_encoding => 'utf-8',
72            config => $config,
73      );
74    
75  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
76    other are optional.
77    
78  =item *  This function will B<die> if normalizastion can't be evaled.
79    
80  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
81  perl code that is evaluated before producing output (value of field will be  C<WebPAC::Normalize::data_structure>.
 interpolated before that)  
82    
83  =item *  =cut
84    
85  optional C<filter{filter_name}> at B<begining of format> will apply perl  sub data_structure {
86  code defined as code ref on format after field substitution to producing          my $arg = {@_};
 output  
87    
88  =item *          die "need row argument" unless ($arg->{row});
89            die "need normalisation argument" unless ($arg->{rules});
90    
91  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.          no strict 'subs';
92            _set_lookup( $arg->{lookup} );
93            _set_rec( $arg->{row} );
94            _set_config( $arg->{config} );
95            _clean_ds( %{ $arg } );
96            eval "$arg->{rules}";
97            die "error evaling $arg->{rules}: $@\n" if ($@);
98    
99  =item *          return _get_ds();
100    }
101    
102  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.  
103    
104  =back  Set current record hash
105    
106  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.  
107    
108    =cut
109    
110    my $rec;
111    
112    sub _set_rec {
113            $rec = shift or die "no record hash";
114    }
115    
116  =head1 FUNCTIONS  =head2 _set_config
117    
118  =head2 new  Set current config hash
119    
120  Create new normalisation object    _set_config( $config );
121    
122    my $n = new WebPAC::Normalize::Something(  Magic keys are:
         filter => {  
                 'filter_name_1' => sub {  
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
         cache_data_structure => './cache/ds/',  
         lookup_regex => $lookup->regex,  
   );  
123    
124  Parametar C<filter> defines user supplied snippets of perl code which can  =over 4
 be use with C<filter{...}> notation.  
125    
126  Optional parameter C<cache_data_structure> defines path to directory  =item _
 in which cache file for C<data_structure> call will be created.  
127    
128  Recommended parametar C<lookup_regex> is used to enable parsing of lookups  Code of current database
 in structures.  
129    
130  =cut  =item _mfn
131    
132    Current MFN
133    
134    =back
135    
136  sub new {  =cut
         my $class = shift;  
         my $self = {@_};  
         bless($self, $class);  
137    
138          $self->setup_cache_dir( $self->{'cache_data_structure'} );  my $config;
139    
140          $self ? return $self : return undef;  sub _set_config {
141            $config = shift;
142  }  }
143    
144  =head2 setup_cache_dir  =head2 _get_ds
145    
146    Return hash formatted as data structure
147    
148      my $ds = _get_ds();
149    
150    =cut
151    
152    my ($out, $marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators);
153    my ($marc_record_offset, $marc_fetch_offset) = (0, 0);
154    
155  Check if specified cache directory exist, and if not, disable caching.  sub _get_ds {
156            return $out;
157    }
158    
159   $setup_cache_dir('./cache/ds/');  =head2 _clean_ds
160    
161  If you pass false or zero value to this function, it will disable  Clean data structure hash for next record
162  cacheing.  
163      _clean_ds();
164    
165  =cut  =cut
166    
167  sub setup_cache_dir {  sub _clean_ds {
168          my $self = shift;          my $a = {@_};
169            ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators) = ();
170            ($marc_record_offset, $marc_fetch_offset) = (0,0);
171            $marc_encoding = $a->{marc_encoding};
172    }
173    
174          my $dir = shift;  =head2 _set_lookup
175    
176          my $log = $self->_get_logger();  Set current lookup hash
177    
178          if ($dir) {    _set_lookup( $lookup );
                 my $msg;  
                 if (! -e $dir) {  
                         $msg = "doesn't exist";  
                 } elsif (! -d $dir) {  
                         $msg = "is not directory";  
                 } elsif (! -w $dir) {  
                         $msg = "not writable";  
                 }  
179    
180                  if ($msg) {  =cut
181                          undef $self->{'cache_data_structure'};  
182                          $log->warn("cache_data_structure $dir $msg, disabling...");  my $lookup;
183                  } else {  
184                          $log->debug("using cache dir $dir");  sub _set_lookup {
185                  }          $lookup = shift;
         } else {  
                 $log->debug("disabling cache");  
                 undef $self->{'cache_data_structure'};  
         }  
186  }  }
187    
188    =head2 _get_marc_fields
189    
190  =head2 data_structure  Get all fields defined by calls to C<marc>
191    
192  Create in-memory data structure which represents normalized layout from          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
 C<conf/normalize/*.xml>.  
193    
194  This structures are used to produce output.  We are using I<magic> which detect repeatable fields only from
195    sequence of field/subfield data generated by normalization.
196    
197   my @ds = $webpac->data_structure($rec);  Repeatable field is created when there is second occurence of same subfield or
198    if any of indicators are different.
199    
200  B<Note: historical oddity follows>  This is sane for most cases. Something like:
201    
202  This method will also set C<< $webpac->{'currnet_filename'} >> if there is    900a-1 900b-1 900c-1
203  C<< <filename> >> tag and C<< $webpac->{'headline'} >> if there is    900a-2 900b-2
204  C<< <headline> >> tag.    900a-3
205    
206  =cut  will be created from any combination of:
207    
208  sub data_structure {    900a-1 900a-2 900a-3 900b-1 900b-2 900c-1
         my $self = shift;  
209    
210          my $log = $self->_get_logger();  and following rules:
211    
212          my $rec = shift;    marc('900','a', rec('200','a') );
213          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    marc('900','b', rec('200','b') );
214      marc('900','c', rec('200','c') );
215    
216          my $cache_file;  which might not be what you have in mind. If you need repeatable subfield,
217    define it using C<marc_repeatable_subfield> like this:
218    
219          if (my $cache_path = $self->{'cache_data_structure'}) {    marc_repeatable_subfield('900','a');
220                  my $id = $rec->{'000'};    marc('900','a', rec('200','a') );
221                  $id = $rec->{'000'}->[0] if ($id =~ m/^ARRAY/o);    marc('900','b', rec('200','b') );
222                  unless (defined($id)) {    marc('900','c', rec('200','c') );
                         $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'};  
                                         }  
                                 }  
                         }  
                 }  
         }  
223    
224          undef $self->{'currnet_filename'};  will create:
         undef $self->{'headline'};  
225    
226          my @sorted_tags;    900a-1 900a-2 900a-3 900b-1 900c-1
227          if ($self->{tags_by_order}) {    900b-2
                 @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;  
         }  
228    
229          my @ds;  There is also support for returning next or specific using:
230    
231          $log->debug("tags: ",sub { join(", ",@sorted_tags) });    while (my $mf = WebPAC::Normalize:_get_marc_fields( fetch_next => 1 ) ) {
232            # do something with $mf
233      }
234    
235          foreach my $field (@sorted_tags) {  will always return fields from next MARC record or
236    
237                  my $row;    my $mf = WebPAC::Normalize::_get_marc_fields( offset => 42 );
238    
239  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  will return 42th copy record (if it exists).
240    
241                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {  =cut
                         my $format = $tag->{'value'} || $tag->{'content'};  
242    
243                          $log->debug("format: $format");  sub _get_marc_fields {
244    
245                          my @v;          my $arg = {@_};
246                          if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {          warn "### _get_marc_fields arg: ", dump($arg), $/ if ($debug > 2);
247                                  @v = $self->fill_in_to_arr($rec,$format);          my $offset = $marc_fetch_offset;
248                          } else {          if ($arg->{offset}) {
249                                  @v = $self->parse_to_arr($rec,$format);                  $offset = $arg->{offset};
250                          }          } elsif($arg->{fetch_next}) {
251                          next if (! @v);                  $marc_fetch_offset++;
252            }
253    
254                          if ($tag->{'sort'}) {          return if (! $marc_record || ref($marc_record) ne 'ARRAY');
                                 @v = $self->sort_arr(@v);  
                         }  
255    
256                          # use format?          warn "### full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 2);
                         if ($tag->{'format_name'}) {  
                                 @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;  
                         }  
257    
258                          if ($field eq 'filename') {          my $marc_rec = $marc_record->[ $offset ];
                                 $self->{'current_filename'} = join('',@v);  
                                 $log->debug("filename: ",$self->{'current_filename'});  
                         } elsif ($field eq 'headline') {  
                                 $self->{'headline'} .= join('',@v);  
                                 $log->debug("headline: ",$self->{'headline'});  
                                 next; # don't return headline in data_structure!  
                         }  
259    
260                          # delimiter will join repeatable fields          warn "## _get_marc_fields (at offset: $offset) -- marc_record = ", dump( @$marc_rec ), $/ if ($debug > 1);
                         if ($tag->{'delimiter'}) {  
                                 @v = ( join($tag->{'delimiter'}, @v) );  
                         }  
261    
262                          # default types          return if (! $marc_rec || ref($marc_rec) ne 'ARRAY' || $#{ $marc_rec } < 0);
                         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;  
263    
264                                  } else {          # first, sort all existing fields
265                                          push @{$row->{$type}}, @v;          # XXX might not be needed, but modern perl might randomize elements in hash
266                                  }          my @sorted_marc_record = sort {
267                          }                  $a->[0] . ( $a->[3] || '' ) cmp $b->[0] . ( $b->[3] || '')
268            } @{ $marc_rec };
269    
270            @sorted_marc_record = @{ $marc_rec };   ### FIXME disable sorting
271            
272            # output marc fields
273            my @m;
274    
275            # count unique field-subfields (used for offset when walking to next subfield)
276            my $u;
277            map { $u->{ $_->[0] . ( $_->[3] || '')  }++ } @sorted_marc_record;
278    
279            if ($debug) {
280                    warn "## marc_repeatable_subfield = ", dump( $marc_repeatable_subfield ), $/ if ( $marc_repeatable_subfield );
281                    warn "## marc_record[$offset] = ", dump( $marc_rec ), $/;
282                    warn "## sorted_marc_record = ", dump( \@sorted_marc_record ), $/;
283                    warn "## subfield count = ", dump( $u ), $/;
284            }
285    
286            my $len = $#sorted_marc_record;
287            my $visited;
288            my $i = 0;
289            my $field;
290    
291            foreach ( 0 .. $len ) {
292    
293                    # find next element which isn't visited
294                    while ($visited->{$i}) {
295                            $i = ($i + 1) % ($len + 1);
296                  }                  }
297    
298                  if ($row) {                  # mark it visited
299                          $row->{'tag'} = $field;                  $visited->{$i}++;
300    
301                          # TODO: name_sigular, name_plural                  my $row = dclone( $sorted_marc_record[$i] );
                         my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};  
                         $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");  
                         }  
302    
303                          push @ds, $row;                  # field and subfield which is key for
304                    # marc_repeatable_subfield and u
305                    my $fsf = $row->[0] . ( $row->[3] || '' );
306    
307                    if ($debug > 1) {
308    
309                            print "### field so far [", $#$field, "] : ", dump( $field ), " ", $field ? 'T' : 'F', $/;
310                            print "### this [$i]: ", dump( $row ),$/;
311                            print "### sf: ", $row->[3], " vs ", $field->[3],
312                                    $marc_repeatable_subfield->{ $row->[0] . $row->[3] } ? ' (repeatable)' : '', $/,
313                                    if ($#$field >= 0);
314    
                         $log->debug("row $field: ",sub { Dumper($row) });  
315                  }                  }
316    
317          }                  # if field exists
318                    if ( $#$field >= 0 ) {
319                            if (
320                                    $row->[0] ne $field->[0] ||             # field
321                                    $row->[1] ne $field->[1] ||             # i1
322                                    $row->[2] ne $field->[2]                # i2
323                            ) {
324                                    push @m, $field;
325                                    warn "## saved/1 ", dump( $field ),$/ if ($debug);
326                                    $field = $row;
327    
328                            } elsif (
329                                    ( $row->[3] lt $field->[-2] )           # subfield which is not next (e.g. a after c)
330                                    ||
331                                    ( $row->[3] eq $field->[-2] &&          # same subfield, but not repeatable
332                                            ! $marc_repeatable_subfield->{ $fsf }
333                                    )
334                            ) {
335                                    push @m, $field;
336                                    warn "## saved/2 ", dump( $field ),$/ if ($debug);
337                                    $field = $row;
338    
339                            } else {
340                                    # append new subfields to existing field
341                                    push @$field, ( $row->[3], $row->[4] );
342                            }
343                    } else {
344                            # insert first field
345                            $field = $row;
346                    }
347    
348          if ($cache_file) {                  if (! $marc_repeatable_subfield->{ $fsf }) {
349                  store {                          # make step to next subfield
350                          ds => \@ds,                          $i = ($i + $u->{ $fsf } ) % ($len + 1);
351                          current_filename => $self->{'current_filename'},                  }
                         headline => $self->{'headline'},  
                 }, $cache_file;  
                 $log->debug("created storable cache file $cache_file");  
352          }          }
353    
354          return @ds;          if ($#$field >= 0) {
355                    push @m, $field;
356                    warn "## saved/3 ", dump( $field ),$/ if ($debug);
357            }
358    
359            return \@m;
360  }  }
361    
362  =head2 parse  =head2 _debug
363    
364  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.  
365    
366   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);    _debug( 2 );
367    
368  =cut  =cut
369    
370  sub parse {  sub _debug {
371          my $self = shift;          my $l = shift;
372            return $debug unless defined($l);
373            warn "debug level $l",$/ if ($l > 0);
374            $debug = $l;
375    }
376    
377          my ($rec, $format_utf8, $i) = @_;  =head1 Functions to create C<data_structure>
378    
379          return if (! $format_utf8);  Those functions generally have to first in your normalization file.
380    
381          my $log = $self->_get_logger();  =head2 tag
382    
383          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  Define new tag for I<search> and I<display>.
384    
385          $i = 0 if (! $i);    tag('Title', rec('200','a') );
386    
         my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  
387    
388          my @out;  =cut
389    
390          $log->debug("format: $format");  sub tag {
391            my $name = shift or die "tag needs name as first argument";
392            my @o = grep { defined($_) && $_ ne '' } @_;
393            return unless (@o);
394            $out->{$name}->{tag} = $name;
395            $out->{$name}->{search} = \@o;
396            $out->{$name}->{display} = \@o;
397    }
398    
399          my $eval_code;  =head2 display
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
400    
401          my $filter_name;  Define tag just for I<display>
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
402    
403          my $prefix;    @v = display('Title', rec('200','a') );
         my $all_found=0;  
404    
405          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  =cut
406    
407                  my $del = $1 || '';  sub display {
408                  $prefix ||= $del if ($all_found == 0);          my $name = shift or die "display needs name as first argument";
409            my @o = grep { defined($_) && $_ ne '' } @_;
410            return unless (@o);
411            $out->{$name}->{tag} = $name;
412            $out->{$name}->{display} = \@o;
413    }
414    
415                  # repeatable index  =head2 search
                 my $r = $i;  
                 $r = 0 if (lc("$2") eq 's');  
416    
417                  my $found = 0;  Prepare values just for I<search>
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);  
418    
419                  if ($found) {    @v = search('Title', rec('200','a') );
                         push @out, $del;  
                         push @out, $tmp;  
                         $all_found += $found;  
                 }  
         }  
420    
421          return if (! $all_found);  =cut
422    
423          my $out = join('',@out);  sub search {
424            my $name = shift or die "search needs name as first argument";
425            my @o = grep { defined($_) && $_ ne '' } @_;
426            return unless (@o);
427            $out->{$name}->{tag} = $name;
428            $out->{$name}->{search} = \@o;
429    }
430    
431          if ($out) {  =head2 marc_leader
                 # add rest of format (suffix)  
                 $out .= $format;  
432    
433                  # add prefix if not there  Setup fields within MARC leader or get leader
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
434    
435                  $log->debug("result: $out");    marc_leader('05','c');
436          }    my $leader = marc_leader();
437    
438          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");  
         }  
439    
440          return $out;  sub marc_leader {
441            my ($offset,$value) = @_;
442    
443            if ($offset) {
444                    $out->{' leader'}->{ $offset } = $value;
445            } else {
446                    return $out->{' leader'};
447            }
448  }  }
449    
450  =head2 parse_to_arr  =head2 marc
451    
452  Similar to C<parse>, but returns array of all repeatable fields  Save value for MARC field
453    
454   my @arr = $webpac->parse_to_arr($rec,'v250^a');    marc('900','a', rec('200','a') );
455      marc('001', rec('000') );
456    
457  =cut  =cut
458    
459  sub parse_to_arr {  sub marc {
460          my $self = shift;          my $f = shift or die "marc needs field";
461            die "marc field must be numer" unless ($f =~ /^\d+$/);
462    
463          my ($rec, $format_utf8) = @_;          my $sf;
464            if ($f >= 10) {
465                    $sf = shift or die "marc needs subfield";
466            }
467    
468          my $log = $self->_get_logger();          foreach (@_) {
469                    my $v = $_;             # make var read-write for Encode
470                    next unless (defined($v) && $v !~ /^\s*$/);
471                    from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
472                    my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
473                    if (defined $sf) {
474                            push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $i1, $i2, $sf => $v ];
475                    } else {
476                            push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $v ];
477                    }
478            }
479    }
480    
481          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  =head2 marc_repeatable_subfield
         return if (! $format_utf8);  
482    
483          my $i = 0;  Save values for MARC repetable subfield
         my @arr;  
484    
485          while (my $v = $self->parse($rec,$format_utf8,$i++)) {    marc_repeatable_subfield('910', 'z', rec('909') );
                 push @arr, $v;  
         }  
486    
487          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  =cut
488    
489          return @arr;  sub marc_repeatable_subfield {
490            my ($f,$sf) = @_;
491            die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);
492            $marc_repeatable_subfield->{ $f . $sf }++;
493            marc(@_);
494  }  }
495    
496    =head2 marc_indicators
497    
498  =head2 fill_in  Set both indicators for MARC field
499    
500  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.  
501    
502   my $text = $webpac->fill_in($rec,'v250^a');  Any indicator value other than C<0-9> will be treated as undefined.
503    
504  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.  
505    
506   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  sub marc_indicators {
507            my $f = shift || die "marc_indicators need field!\n";
508            my ($i1,$i2) = @_;
509            die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));
510            die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));
511    
512  This function B<does not> perform parsing of format to inteligenty skip          $i1 = ' ' if ($i1 !~ /^\d$/);
513  delimiters before fields which aren't used.          $i2 = ' ' if ($i2 !~ /^\d$/);
514            @{ $marc_indicators->{$f} } = ($i1,$i2);
515    }
516    
517  This method will automatically decode UTF-8 string to local code page  =head2 marc_compose
 if needed.  
518    
519  =cut  Save values for each MARC subfield explicitly
520    
521  sub fill_in {    marc_compose('900',
522          my $self = shift;          'a', rec('200','a')
523            'b', rec('201','a')
524            'a', rec('200','b')
525            'c', rec('200','c')
526      );
527    
528    =cut
529    
530          my $log = $self->_get_logger();  sub marc_compose {
531            my $f = shift or die "marc_compose needs field";
532            die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
533    
534          my $rec = shift || $log->logconfess("need data record");          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
535          my $format = shift || $log->logconfess("need format to parse");          my $m = [ $f, $i1, $i2 ];
         # iteration (for repeatable fields)  
         my $i = shift || 0;  
536    
537          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));          warn "### marc_compose input subfields = ", dump(@_),$/ if ($debug > 2);
538    
539          # FIXME remove for speedup?          while (@_) {
540          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);                  my $sf = shift or die "marc_compose $f needs subfield";
541                    my $v = shift;
542    
543          if (utf8::is_utf8($format)) {                  next unless (defined($v) && $v !~ /^\s*$/);
544                  $format = $self->_x($format);                  from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
545                    push @$m, ( $sf, $v );
546                    warn "## ++ marc_compose($f,$sf,$v) ", dump( $m ),$/ if ($debug > 1);
547          }          }
548    
549          my $found = 0;          warn "## marc_compose current marc = ", dump( $m ),$/ if ($debug > 1);
550    
551          my $eval_code;          push @{ $marc_record->[ $marc_record_offset ] }, $m if ($#{$m} > 2);
552          # remove eval{...} from beginning  }
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
553    
554          my $filter_name;  =head2 marc_duplicate
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
555    
556          # do actual replacement of placeholders  Generate copy of current MARC record and continue working on copy
         # 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;  
557    
558          if ($found) {    marc_duplicate();
559                  $log->debug("format: $format");  
560                  if ($eval_code) {  Copies can be accessed using C<< _get_marc_fields( fetch_next => 1 ) >> or
561                          my $eval = $self->fill_in($rec,$eval_code,$i);  C<< _get_marc_fields( offset => 42 ) >>.
562                          return if (! $self->_eval($eval));  
563                  }  =cut
564                  if ($filter_name && $self->{'filter'}->{$filter_name}) {  
565                          $log->debug("filter '$filter_name' for $format");  sub marc_duplicate {
566                          $format = $self->{'filter'}->{$filter_name}->($format);           my $m = $marc_record->[ -1 ];
567                          return unless(defined($format));           die "can't duplicate record which isn't defined" unless ($m);
568                          $log->debug("filter result: $format");           push @{ $marc_record }, dclone( $m );
569                  }           warn "## marc_duplicate = ", dump(@$marc_record), $/ if ($debug > 1);
570                  # do we have lookups?           $marc_record_offset = $#{ $marc_record };
571                  if ($self->{'lookup'}) {           warn "## marc_record_offset = $marc_record_offset", $/ if ($debug > 1);
                         return $self->lookup($format);  
                 } else {  
                         return $format;  
                 }  
         } else {  
                 return;  
         }  
572  }  }
573    
574    =head2 marc_remove
575    
576    Remove some field or subfield from MARC record.
577    
578  =head2 fill_in_to_arr    marc_remove('200');
579      marc_remove('200','a');
580    
581  Similar to C<fill_in>, but returns array of all repeatable fields. Usable  This will erase field C<200> or C<200^a> from current MARC record.
 for fields which have lookups, so they shouldn't be parsed but rather  
 C<fill_id>ed.  
582    
583   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');  This is useful after calling C<marc_duplicate> or on it's own (but, you
584    should probably just remove that subfield definition if you are not
585    using C<marc_duplicate>).
586    
587    FIXME: support fields < 10.
588    
589  =cut  =cut
590    
591  sub fill_in_to_arr {  sub marc_remove {
592          my $self = shift;          my ($f, $sf) = @_;
593    
594          my ($rec, $format_utf8) = @_;          die "marc_remove needs record number" unless defined($f);
595    
596          my $log = $self->_get_logger();          my $marc = $marc_record->[ $marc_record_offset ];
597    
598          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);          warn "### marc_remove before = ", dump( $marc ), $/ if ($debug > 2);
         return if (! $format_utf8);  
599    
600          my $i = 0;          my $i = 0;
601          my @arr;          foreach ( 0 .. $#{ $marc } ) {
602                    last unless (defined $marc->[$i]);
603          while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {                  warn "#### working on ",dump( @{ $marc->[$i] }), $/ if ($debug > 3);
604                  push @arr, @v;                  if ($marc->[$i]->[0] eq $f) {
605                            if (! defined $sf) {
606                                    # remove whole field
607                                    splice @$marc, $i, 1;
608                                    warn "#### slice \@\$marc, $i, 1 = ",dump( @{ $marc }), $/ if ($debug > 3);
609                                    $i--;
610                            } else {
611                                    foreach my $j ( 0 .. (( $#{ $marc->[$i] } - 3 ) / 2) ) {
612                                            my $o = ($j * 2) + 3;
613                                            if ($marc->[$i]->[$o] eq $sf) {
614                                                    # remove subfield
615                                                    splice @{$marc->[$i]}, $o, 2;
616                                                    warn "#### slice \@{\$marc->[$i]}, $o, 2 = ", dump( @{ $marc }), $/ if ($debug > 3);
617                                                    # is record now empty?
618                                                    if ($#{ $marc->[$i] } == 2) {
619                                                            splice @$marc, $i, 1;
620                                                            warn "#### slice \@\$marc, $i, 1 = ", dump( @{ $marc }), $/ if ($debug > 3);
621                                                            $i--;
622                                                    };
623                                            }
624                                    }
625                            }
626                    }
627                    $i++;
628          }          }
629    
630          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);          warn "### marc_remove($f", $sf ? ",$sf" : "", ") after = ", dump( $marc ), $/ if ($debug > 2);
631    
632          return @arr;          $marc_record->[ $marc_record_offset ] = $marc;
 }  
633    
634            warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
635    }
636    
637  =head2 get_data  =head1 Functions to extract data from input
638    
639  Returns value from record.  This function should be used inside functions to create C<data_structure> described
640    above.
641    
642   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);  =head2 rec1
643    
644  Arguments are:  Return all values in some field
 record reference C<$rec>,  
 field C<$f>,  
 optional subfiled C<$sf>,  
 index for repeatable values C<$i>.  
645    
646  Optinal variable C<$found> will be incremeted if there    @v = rec1('200')
 is field.  
647    
648  Returns value or empty string.  TODO: order of values is probably same as in source data, need to investigate that
649    
650  =cut  =cut
651    
652  sub get_data {  sub rec1 {
653          my $self = shift;          my $f = shift;
654            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
655          my ($rec,$f,$sf,$i,$found) = @_;          return unless (defined($rec) && defined($rec->{$f}));
656            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
657          if ($$rec->{$f}) {          if (ref($rec->{$f}) eq 'ARRAY') {
658                  return '' if (! $$rec->{$f}->[$i]);                  return map {
659                  no strict 'refs';                          if (ref($_) eq 'HASH') {
660                  if ($sf && $$rec->{$f}->[$i]->{$sf}) {                                  values %{$_};
                         $$found++ if (defined($$found));  
                         return $$rec->{$f}->[$i]->{$sf};  
                 } elsif ($$rec->{$f}->[$i]) {  
                         $$found++ if (defined($$found));  
                         # it still might have subfield, just  
                         # not specified, so we'll dump all  
                         if ($$rec->{$f}->[$i] =~ /HASH/o) {  
                                 my $out;  
                                 foreach my $k (keys %{$$rec->{$f}->[$i]}) {  
                                         $out .= $$rec->{$f}->[$i]->{$k}." ";  
                                 }  
                                 return $out;  
661                          } else {                          } else {
662                                  return $$rec->{$f}->[$i];                                  $_;
663                          }                          }
664                    } @{ $rec->{$f} };
665            } elsif( defined($rec->{$f}) ) {
666                    return $rec->{$f};
667            }
668    }
669    
670    =head2 rec2
671    
672    Return all values in specific field and subfield
673    
674      @v = rec2('200','a')
675    
676    =cut
677    
678    sub rec2 {
679            my $f = shift;
680            return unless (defined($rec && $rec->{$f}));
681            my $sf = shift;
682            warn "rec2($f,$sf) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
683            return map {
684                    if (ref($_->{$sf}) eq 'ARRAY') {
685                            @{ $_->{$sf} };
686                    } else {
687                            $_->{$sf};
688                  }                  }
689            } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
690    }
691    
692    =head2 rec
693    
694    syntaxtic sugar for
695    
696      @v = rec('200')
697      @v = rec('200','a')
698    
699    =cut
700    
701    sub rec {
702            my @out;
703            if ($#_ == 0) {
704                    @out = rec1(@_);
705            } elsif ($#_ == 1) {
706                    @out = rec2(@_);
707            }
708            if (@out) {
709                    return @out;
710          } else {          } else {
711                  return '';                  return '';
712          }          }
713  }  }
714    
715    =head2 regex
716    
717  =head2 apply_format  Apply regex to some or all values
718    
719  Apply format specified in tag with C<format_name="name"> and    @v = regex( 's/foo/bar/g', @v );
 C<format_delimiter=";;">.  
720    
721   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  =cut
722    
723    sub regex {
724            my $r = shift;
725            my @out;
726            #warn "r: $r\n", dump(\@_);
727            foreach my $t (@_) {
728                    next unless ($t);
729                    eval "\$t =~ $r";
730                    push @out, $t if ($t && $t ne '');
731            }
732            return @out;
733    }
734    
735    =head2 prefix
736    
737    Prefix all values with a string
738    
739  Formats can contain C<lookup{...}> if you need them.    @v = prefix( 'my_', @v );
740    
741  =cut  =cut
742    
743  sub apply_format {  sub prefix {
744          my $self = shift;          my $p = shift or return;
745            return map { $p . $_ } grep { defined($_) } @_;
746    }
747    
748          my ($name,$delimiter,$data) = @_;  =head2 suffix
749    
750          my $log = $self->_get_logger();  suffix all values with a string
751    
752          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;  
         }  
753    
754          $log->warn("no delimiter for format $name") if (! $delimiter);  =cut
755    
756          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  sub suffix {
757            my $s = shift or die "suffix needs string as first argument";
758            return map { $_ . $s } grep { defined($_) } @_;
759    }
760    
761          my @data = split(/\Q$delimiter\E/, $data);  =head2 surround
762    
763          my $out = sprintf($format, @data);  surround all values with a two strings
         $log->debug("using format $name [$format] on $data to produce: $out");  
764    
765          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {    @v = surround( 'prefix_', '_suffix', @v );
                 return $self->lookup($out);  
         } else {  
                 return $out;  
         }  
766    
767    =cut
768    
769    sub surround {
770            my $p = shift or die "surround need prefix as first argument";
771            my $s = shift or die "surround needs suffix as second argument";
772            return map { $p . $_ . $s } grep { defined($_) } @_;
773  }  }
774    
775  =head2 sort_arr  =head2 first
776    
777  Sort array ignoring case and html in data  Return first element
778    
779   my @sorted = $webpac->sort_arr(@unsorted);    $v = first( @v );
780    
781  =cut  =cut
782    
783  sub sort_arr {  sub first {
784          my $self = shift;          my $r = shift;
785            return $r;
786    }
787    
788    =head2 lookup
789    
790          my $log = $self->_get_logger();  Consult lookup hashes for some value
791    
792          # FIXME add Schwartzian Transformation?    @v = lookup( $v );
793      @v = lookup( @v );
794    
795          my @sorted = sort {  =cut
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
796    
797          return @sorted;  sub lookup {
798            my $k = shift or return;
799            return unless (defined($lookup->{$k}));
800            if (ref($lookup->{$k}) eq 'ARRAY') {
801                    return @{ $lookup->{$k} };
802            } else {
803                    return $lookup->{$k};
804            }
805  }  }
806    
807    =head2 config
808    
809  =head1 INTERNAL METHODS  Consult config values stored in C<config.yml>
810    
811  =head2 _sort_by_order    # return database code (key under databases in yaml)
812      $database_code = config();    # use _ from hash
813      $database_name = config('name');
814      $database_input_name = config('input name');
815      $tag = config('input normalize tag');
816    
817  Sort xml tags data structure accoding to C<order=""> attribute.  Up to three levels are supported.
818    
819  =cut  =cut
820    
821  sub _sort_by_order {  sub config {
822          my $self = shift;          return unless ($config);
823    
824            my $p = shift;
825    
826            $p ||= '';
827    
828          my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||          my $v;
829                  $self->{'import_xml'}->{'indexer'}->{$a};  
830          my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||          warn "### getting config($p)\n" if ($debug > 1);
831                  $self->{'import_xml'}->{'indexer'}->{$b};  
832            my @p = split(/\s+/,$p);
833            if ($#p < 0) {
834                    $v = $config->{ '_' };  # special, database code
835            } else {
836    
837          return $va <=> $vb;                  my $c = dclone( $config );
838    
839                    foreach my $k (@p) {
840                            warn "### k: $k c = ",dump($c),$/ if ($debug > 1);
841                            if (ref($c) eq 'ARRAY') {
842                                    $c = shift @$c;
843                                    warn "config($p) taking first occurence of '$k', probably not what you wanted!\n";
844                                    last;
845                            }
846    
847                            if (! defined($c->{$k}) ) {
848                                    $c = undef;
849                                    last;
850                            } else {
851                                    $c = $c->{$k};
852                            }
853                    }
854                    $v = $c if ($c);
855    
856            }
857    
858            warn "## config( '$p' ) = ",dump( $v ),$/ if ($v && $debug);
859            warn "config( '$p' ) is empty\n" if (! $v);
860    
861            return $v;
862  }  }
863    
864  =head2 _x  =head2 id
865    
866  Convert strings from C<conf/normalize/*.xml> encoding into application  Returns unique id of this record
 specific encoding (optinally specified using C<code_page> to C<new>  
 constructor).  
867    
868   my $text = $n->_x('normalize text string');    $id = id();
869    
870  This is a stub so that other modules doesn't have to implement it.  Returns C<42/2> for 2nd occurence of MFN 42.
871    
872  =cut  =cut
873    
874  sub _x {  sub id {
875          my $self = shift;          my $mfn = $config->{_mfn} || die "no _mfn in config data";
876          return shift;          return $mfn . $#{$marc_record} ? $#{$marc_record} + 1 : '';
877  }  }
878    
879    =head2 join_with
880    
881    Joins walues with some delimiter
882    
883      $v = join_with(", ", @v);
884    
885  =head1 AUTHOR  =cut
886    
887    sub join_with {
888            my $d = shift;
889            warn "### join_with('$d',",dump(@_),")\n" if ($debug > 2);
890            my $v = join($d, grep { defined($_) && $_ ne '' } @_);
891            return '' unless defined($v);
892            return $v;
893    }
894    
895  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  =head2 split_rec_on
896    
897  =head1 COPYRIGHT & LICENSE  Split record subfield on some regex and take one of parts out
898    
899  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.    $a_before_semi_column =
900            split_rec_on('200','a', /\s*;\s*/, $part);
901    
902  This program is free software; you can redistribute it and/or modify it  C<$part> is optional number of element. First element is
903  under the same terms as Perl itself.  B<1>, not 0!
904    
905    If there is no C<$part> parameter or C<$part> is 0, this function will
906    return all values produced by splitting.
907    
908  =cut  =cut
909    
910  1; # End of WebPAC::DB  sub split_rec_on {
911            die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
912    
913            my ($fld, $sf, $regex, $part) = @_;
914            warn "### regex ", ref($regex), $regex, $/ if ($debug > 2);
915    
916            my @r = rec( $fld, $sf );
917            my $v = shift @r;
918            warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
919    
920            return '' if( ! defined($v) || $v =~ /^\s*$/);
921    
922            my @s = split( $regex, $v );
923            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
924            if ($part && $part > 0) {
925                    return $s[ $part - 1 ];
926            } else {
927                    return @s;
928            }
929    }
930    
931    # END
932    1;

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

  ViewVC Help
Powered by ViewVC 1.1.26