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

Legend:
Removed from v.14  
changed lines
  Added in v.667

  ViewVC Help
Powered by ViewVC 1.1.26