/[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 619 by dpavlin, Fri Aug 25 12:31:06 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            marc_original_order
13    
14            rec1 rec2 rec
15            regex prefix suffix surround
16            first lookup join_with
17    
18            split_rec_on
19    /;
20    
21  use warnings;  use warnings;
22  use strict;  use strict;
23  use Data::Dumper;  
24  use Storable;  #use base qw/WebPAC::Common/;
25    use Data::Dump qw/dump/;
26    use Encode qw/from_to/;
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.16
40    
41  =cut  =cut
42    
43  our $VERSION = '0.01';  our $VERSION = '0.16';
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            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            return _get_ds();
101    }
102    
103    =head2 _set_rec
104    
105    Set current record hash
106    
107      _set_rec( $rec );
108    
109    =cut
110    
111          $self->setup_cache_dir( $self->{'cache_data_structure'} );  my $rec;
112    
113          $self ? return $self : return undef;  sub _set_rec {
114            $rec = shift or die "no record hash";
115  }  }
116    
117  =head2 setup_cache_dir  =head2 _set_config
118    
119  Check if specified cache directory exist, and if not, disable caching.  Set current config hash
120    
121   $setup_cache_dir('./cache/ds/');    _set_config( $config );
122    
123  If you pass false or zero value to this function, it will disable  Magic keys are:
124  cacheing.  
125    =over 4
126    
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();
165  C<conf/normalize/*.xml>.  
166    =cut
167    
168  This structures are used to produce output.  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 );
239                                          push @{$row->{$type}}, @v;  
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] );
303                          my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};  
304                          $row->{'name'} = $name ? $self->_x($name) : $field;                  # field and subfield which is key for
305                    # marc_repeatable_subfield and u
306                          # post-sort all values in field                  my $fsf = $row->[0] . ( $row->[3] || '' );
307                          if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {  
308                                  $log->warn("sort at field tag not implemented");                  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    
316                    }
317    
318                          push @ds, $row;                  # 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                          $log->debug("row $field: ",sub { Dumper($row) });                          } 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  Apply format specified in tag with C<format_name="name"> and  =head2 tag
 C<format_delimiter=";;">.  
383    
384   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  Define new tag for I<search> and I<display>.
385    
386      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    =head2 display
401    
402          my ($name,$delimiter,$data) = @_;  Define tag just for I<display>
403    
404          my $log = $self->_get_logger();    @v = display('Title', rec('200','a') );
405    
406          if (! $self->{'import_xml'}->{'format'}->{$name}) {  =cut
407                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});  
408                  return $data;  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          $log->warn("no delimiter for format $name") if (! $delimiter);  Prepare values just for I<search>
419    
420          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");    @v = search('Title', rec('200','a') );
421    
422          my @data = split(/\Q$delimiter\E/, $data);  =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    Setup fields within MARC leader or get leader
435    
436      marc_leader('05','c');
437      my $leader = marc_leader();
438    
439    =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                    from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
473                    my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
474                    if (defined $sf) {
475                            push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $i1, $i2, $sf => $v ];
476                    } else {
477                            push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $v ];
478                    }
479            }
480  }  }
481    
482  =head2 parse  =head2 marc_repeatable_subfield
483    
484  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.  
485    
486   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);    marc_repeatable_subfield('910', 'z', rec('909') );
487    
488  =cut  =cut
489    
490  sub parse {  sub marc_repeatable_subfield {
491          my $self = shift;          my ($f,$sf) = @_;
492            die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);
493            $marc_repeatable_subfield->{ $f . $sf }++;
494            marc(@_);
495    }
496    
497          my ($rec, $format_utf8, $i) = @_;  =head2 marc_indicators
498    
499          return if (! $format_utf8);  Set both indicators for MARC field
500    
501          my $log = $self->_get_logger();    marc_indicators('900', ' ', 1);
502    
503          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  Any indicator value other than C<0-9> will be treated as undefined.
504    
505          $i = 0 if (! $i);  =cut
506    
507          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  sub marc_indicators {
508            my $f = shift || die "marc_indicators need field!\n";
509            my ($i1,$i2) = @_;
510            die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));
511            die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));
512    
513          my @out;          $i1 = ' ' if ($i1 !~ /^\d$/);
514            $i2 = ' ' if ($i2 !~ /^\d$/);
515            @{ $marc_indicators->{$f} } = ($i1,$i2);
516    }
517    
518          $log->debug("format: $format");  =head2 marc_compose
519    
520          my $eval_code;  Save values for each MARC subfield explicitly
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
521    
522          my $filter_name;    marc_compose('900',
523          # remove filter{...} from beginning          'a', rec('200','a')
524          $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);          'b', rec('201','a')
525            'a', rec('200','b')
526            'c', rec('200','c')
527      );
528    
529    If you specify C<+> for subfield, value will be appended
530    to previous defined subfield.
531    
532    =cut
533    
534          my $prefix;  sub marc_compose {
535          my $all_found=0;          my $f = shift or die "marc_compose needs field";
536            die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
537    
538          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
539            my $m = [ $f, $i1, $i2 ];
540    
541                  my $del = $1 || '';          warn "### marc_compose input subfields = ", dump(@_),$/ if ($debug > 2);
                 $prefix ||= $del if ($all_found == 0);  
542    
543                  # repeatable index          if ($#_ % 2 != 1) {
544                  my $r = $i;                  die "ERROR: marc_compose",dump($f,@_)," not valid (must be even).\nDo you need to add first() or join() around some argument?\n";
545                  $r = 0 if (lc("$2") eq 's');          }
546    
547                  my $found = 0;          while (@_) {
548                  my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);                  my $sf = shift;
549                    my $v = shift;
550    
551                  if ($found) {                  next unless (defined($v) && $v !~ /^\s*$/);
552                          push @out, $del;                  from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
553                          push @out, $tmp;                  warn "## ++ marc_compose($f,$sf,$v) ", dump( $m ),$/ if ($debug > 1);
554                          $all_found += $found;                  if ($sf ne '+') {
555                            push @$m, ( $sf, $v );
556                    } else {
557                            $m->[ $#$m ] .= $v;
558                  }                  }
559          }          }
560    
561          return if (! $all_found);          warn "## marc_compose current marc = ", dump( $m ),$/ if ($debug > 1);
562    
563          my $out = join('',@out);          push @{ $marc_record->[ $marc_record_offset ] }, $m if ($#{$m} > 2);
564    }
565    
566          if ($out) {  =head2 marc_duplicate
                 # add rest of format (suffix)  
                 $out .= $format;  
567    
568                  # 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/);  
569    
570                  $log->debug("result: $out");    marc_duplicate();
         }  
571    
572          if ($eval_code) {  Copies can be accessed using C<< _get_marc_fields( fetch_next => 1 ) >> or
573                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;  C<< _get_marc_fields( offset => 42 ) >>.
574                  $log->debug("about to eval{$eval} format: $out");  
575                  return if (! $self->_eval($eval));  =cut
576    
577    sub marc_duplicate {
578             my $m = $marc_record->[ -1 ];
579             die "can't duplicate record which isn't defined" unless ($m);
580             push @{ $marc_record }, dclone( $m );
581             warn "## marc_duplicate = ", dump(@$marc_record), $/ if ($debug > 1);
582             $marc_record_offset = $#{ $marc_record };
583             warn "## marc_record_offset = $marc_record_offset", $/ if ($debug > 1);
584    }
585    
586    =head2 marc_remove
587    
588    Remove some field or subfield from MARC record.
589    
590      marc_remove('200');
591      marc_remove('200','a');
592    
593    This will erase field C<200> or C<200^a> from current MARC record.
594    
595    This is useful after calling C<marc_duplicate> or on it's own (but, you
596    should probably just remove that subfield definition if you are not
597    using C<marc_duplicate>).
598    
599    FIXME: support fields < 10.
600    
601    =cut
602    
603    sub marc_remove {
604            my ($f, $sf) = @_;
605    
606            die "marc_remove needs record number" unless defined($f);
607    
608            my $marc = $marc_record->[ $marc_record_offset ];
609    
610            warn "### marc_remove before = ", dump( $marc ), $/ if ($debug > 2);
611    
612            my $i = 0;
613            foreach ( 0 .. $#{ $marc } ) {
614                    last unless (defined $marc->[$i]);
615                    warn "#### working on ",dump( @{ $marc->[$i] }), $/ if ($debug > 3);
616                    if ($marc->[$i]->[0] eq $f) {
617                            if (! defined $sf) {
618                                    # remove whole field
619                                    splice @$marc, $i, 1;
620                                    warn "#### slice \@\$marc, $i, 1 = ",dump( @{ $marc }), $/ if ($debug > 3);
621                                    $i--;
622                            } else {
623                                    foreach my $j ( 0 .. (( $#{ $marc->[$i] } - 3 ) / 2) ) {
624                                            my $o = ($j * 2) + 3;
625                                            if ($marc->[$i]->[$o] eq $sf) {
626                                                    # remove subfield
627                                                    splice @{$marc->[$i]}, $o, 2;
628                                                    warn "#### slice \@{\$marc->[$i]}, $o, 2 = ", dump( @{ $marc }), $/ if ($debug > 3);
629                                                    # is record now empty?
630                                                    if ($#{ $marc->[$i] } == 2) {
631                                                            splice @$marc, $i, 1;
632                                                            warn "#### slice \@\$marc, $i, 1 = ", dump( @{ $marc }), $/ if ($debug > 3);
633                                                            $i--;
634                                                    };
635                                            }
636                                    }
637                            }
638                    }
639                    $i++;
640          }          }
641    
642            warn "### marc_remove($f", $sf ? ",$sf" : "", ") after = ", dump( $marc ), $/ if ($debug > 2);
643    
644            $marc_record->[ $marc_record_offset ] = $marc;
645    
646            warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
647    }
648    
649    =head2 marc_original_order
650    
651    Copy all subfields preserving original order to marc field.
652    
653      marc_original_order( marc_field_number, original_input_field_number );
654    
655    Please note that field numbers are consistent with other commands (marc
656    field number first), but somewhat counter-intuitive (destination and then
657    source).
658    
659    You might want to use this command if you are just renaming subfields or
660    using pre-processing modify_record in C<config.yml> and don't need any
661    post-processing or want to preserve order of original subfields.
662    
663    
664    =cut
665    
666    sub marc_original_order {
667    
668            my ($to, $from) = @_;
669            die "marc_original_order needs from and to fields\n" unless ($from && $to);
670    
671            return unless defined($rec->{$from});
672    
673            my $r = $rec->{$from};
674            die "record field $from isn't array\n" unless (ref($r) eq 'ARRAY');
675    
676            my ($i1,$i2) = defined($marc_indicators->{$to}) ? @{ $marc_indicators->{$to} } : (' ',' ');
677            warn "## marc_original_order($to,$from) source = ", dump( $r ),$/ if ($debug > 1);
678    
679            foreach my $d (@$r) {
680    
681                    if (! defined($d->{subfields}) && ref($d->{subfields}) ne 'ARRAY') {
682                            warn "# marc_original_order($to,$from): field $from doesn't have subfields specification\n";
683                            next;
684                    }
685                    
686          if ($filter_name && $self->{'filter'}->{$filter_name}) {                  my @sfs = @{ $d->{subfields} };
687                  $log->debug("about to filter{$filter_name} format: $out");  
688                  $out = $self->{'filter'}->{$filter_name}->($out);                  die "field $from doesn't have even number of subfields specifications\n" unless($#sfs % 2 == 1);
689                  return unless(defined($out));  
690                  $log->debug("filter result: $out");                  warn "#--> d: ",dump($d), "\n#--> sfs: ",dump(@sfs),$/ if ($debug > 2);
691    
692                    my $m = [ $to, $i1, $i2 ];
693    
694                    while (my $sf = shift @sfs) {
695    
696                            warn "#--> sf: ",dump($sf), $/ if ($debug > 2);
697                            my $offset = shift @sfs;
698                            die "corrupted sufields specification for field $from\n" unless defined($offset);
699    
700                            my $v;
701                            if (ref($d->{$sf}) eq 'ARRAY') {
702                                    $v = $d->{$sf}->[$offset] if (defined($d->{$sf}->[$offset]));
703                            } elsif ($offset == 0) {
704                                    $v = $d->{$sf};
705                            } else {
706                                    die "field $from subfield '$sf' need occurence $offset which doesn't exist", dump($d->{$sf});
707                            }
708                            push @$m, ( $sf, $v ) if (defined($v));
709                    }
710    
711                    if ($#{$m} > 2) {
712                            push @{ $marc_record->[ $marc_record_offset ] }, $m;
713                    }
714          }          }
715    
716          return $out;          warn "## marc_record = ", dump( $marc_record ),$/ if ($debug > 1);
717  }  }
718    
 =head2 parse_to_arr  
719    
720  Similar to C<parse>, but returns array of all repeatable fields  =head1 Functions to extract data from input
721    
722    This function should be used inside functions to create C<data_structure> described
723    above.
724    
725   my @arr = $webpac->parse_to_arr($rec,'v250^a');  =head2 rec1
726    
727    Return all values in some field
728    
729      @v = rec1('200')
730    
731    TODO: order of values is probably same as in source data, need to investigate that
732    
733  =cut  =cut
734    
735  sub parse_to_arr {  sub rec1 {
736          my $self = shift;          my $f = shift;
737            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
738            return unless (defined($rec) && defined($rec->{$f}));
739            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
740            if (ref($rec->{$f}) eq 'ARRAY') {
741                    return map {
742                            if (ref($_) eq 'HASH') {
743                                    values %{$_};
744                            } else {
745                                    $_;
746                            }
747                    } @{ $rec->{$f} };
748            } elsif( defined($rec->{$f}) ) {
749                    return $rec->{$f};
750            }
751    }
752    
753          my ($rec, $format_utf8) = @_;  =head2 rec2
754    
755          my $log = $self->_get_logger();  Return all values in specific field and subfield
756    
757          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    @v = rec2('200','a')
         return if (! $format_utf8);  
758    
759          my $i = 0;  =cut
760          my @arr;  
761    sub rec2 {
762            my $f = shift;
763            return unless (defined($rec && $rec->{$f}));
764            my $sf = shift;
765            warn "rec2($f,$sf) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
766            return map {
767                    if (ref($_->{$sf}) eq 'ARRAY') {
768                            @{ $_->{$sf} };
769                    } else {
770                            $_->{$sf};
771                    }
772            } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
773    }
774    
775    =head2 rec
776    
777    syntaxtic sugar for
778    
779      @v = rec('200')
780      @v = rec('200','a')
781    
782          while (my $v = $self->parse($rec,$format_utf8,$i++)) {  =cut
783                  push @arr, $v;  
784    sub rec {
785            my @out;
786            if ($#_ == 0) {
787                    @out = rec1(@_);
788            } elsif ($#_ == 1) {
789                    @out = rec2(@_);
790            }
791            if (@out) {
792                    return @out;
793            } else {
794                    return '';
795          }          }
796    }
797    
798    =head2 regex
799    
800    Apply regex to some or all values
801    
802          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);    @v = regex( 's/foo/bar/g', @v );
803    
804          return @arr;  =cut
805    
806    sub regex {
807            my $r = shift;
808            my @out;
809            #warn "r: $r\n", dump(\@_);
810            foreach my $t (@_) {
811                    next unless ($t);
812                    eval "\$t =~ $r";
813                    push @out, $t if ($t && $t ne '');
814            }
815            return @out;
816  }  }
817    
818  =head2 fill_in_to_arr  =head2 prefix
819    
820  Similar to C<fill_in>, but returns array of all repeatable fields. Usable  Prefix all values with a string
 for fields which have lookups, so they shouldn't be parsed but rather  
 C<fill_id>ed.  
821    
822   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');    @v = prefix( 'my_', @v );
823    
824  =cut  =cut
825    
826  sub fill_in_to_arr {  sub prefix {
827          my $self = shift;          my $p = shift or return;
828            return map { $p . $_ } grep { defined($_) } @_;
829    }
830    
831          my ($rec, $format_utf8) = @_;  =head2 suffix
832    
833          my $log = $self->_get_logger();  suffix all values with a string
834    
835          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    @v = suffix( '_my', @v );
         return if (! $format_utf8);  
836    
837          my $i = 0;  =cut
         my @arr;  
838    
839          while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {  sub suffix {
840                  push @arr, @v;          my $s = shift or die "suffix needs string as first argument";
841          }          return map { $_ . $s } grep { defined($_) } @_;
842    }
843    
844    =head2 surround
845    
846    surround all values with a two strings
847    
848      @v = surround( 'prefix_', '_suffix', @v );
849    
850          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  =cut
851    
852          return @arr;  sub surround {
853            my $p = shift or die "surround need prefix as first argument";
854            my $s = shift or die "surround needs suffix as second argument";
855            return map { $p . $_ . $s } grep { defined($_) } @_;
856  }  }
857    
858  =head2 sort_arr  =head2 first
859    
860  Sort array ignoring case and html in data  Return first element
861    
862   my @sorted = $webpac->sort_arr(@unsorted);    $v = first( @v );
863    
864  =cut  =cut
865    
866  sub sort_arr {  sub first {
867          my $self = shift;          my $r = shift;
868            return $r;
869    }
870    
871    =head2 lookup
872    
873          my $log = $self->_get_logger();  Consult lookup hashes for some value
874    
875          # FIXME add Schwartzian Transformation?    @v = lookup( $v );
876      @v = lookup( @v );
877    
878          my @sorted = sort {  =cut
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
879    
880          return @sorted;  sub lookup {
881            my $k = shift or return;
882            return unless (defined($lookup->{$k}));
883            if (ref($lookup->{$k}) eq 'ARRAY') {
884                    return @{ $lookup->{$k} };
885            } else {
886                    return $lookup->{$k};
887            }
888  }  }
889    
890    =head2 config
891    
892  =head2 _sort_by_order  Consult config values stored in C<config.yml>
893    
894  Sort xml tags data structure accoding to C<order=""> attribute.    # return database code (key under databases in yaml)
895      $database_code = config();    # use _ from hash
896      $database_name = config('name');
897      $database_input_name = config('input name');
898      $tag = config('input normalize tag');
899    
900    Up to three levels are supported.
901    
902  =cut  =cut
903    
904  sub _sort_by_order {  sub config {
905          my $self = shift;          return unless ($config);
906    
907            my $p = shift;
908    
909            $p ||= '';
910    
911            my $v;
912    
913            warn "### getting config($p)\n" if ($debug > 1);
914    
915            my @p = split(/\s+/,$p);
916            if ($#p < 0) {
917                    $v = $config->{ '_' };  # special, database code
918            } else {
919    
920                    my $c = dclone( $config );
921    
922                    foreach my $k (@p) {
923                            warn "### k: $k c = ",dump($c),$/ if ($debug > 1);
924                            if (ref($c) eq 'ARRAY') {
925                                    $c = shift @$c;
926                                    warn "config($p) taking first occurence of '$k', probably not what you wanted!\n";
927                                    last;
928                            }
929    
930                            if (! defined($c->{$k}) ) {
931                                    $c = undef;
932                                    last;
933                            } else {
934                                    $c = $c->{$k};
935                            }
936                    }
937                    $v = $c if ($c);
938    
939            }
940    
941          my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||          warn "## config( '$p' ) = ",dump( $v ),$/ if ($v && $debug);
942                  $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};  
943    
944          return $va <=> $vb;          return $v;
945  }  }
946    
947  =head2 _x  =head2 id
948    
949  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.  
950    
951   my $text = $n->_x('normalize text string');    $id = id();
952    
953  This is a stub so that other modules doesn't have to implement it.  Returns C<42/2> for 2nd occurence of MFN 42.
954    
955  =cut  =cut
956    
957  sub _x {  sub id {
958          my $self = shift;          my $mfn = $config->{_mfn} || die "no _mfn in config data";
959          return shift;          return $mfn . $#{$marc_record} ? $#{$marc_record} + 1 : '';
960  }  }
961    
962    =head2 join_with
963    
964    Joins walues with some delimiter
965    
966      $v = join_with(", ", @v);
967    
968    =cut
969    
970    sub join_with {
971            my $d = shift;
972            warn "### join_with('$d',",dump(@_),")\n" if ($debug > 2);
973            my $v = join($d, grep { defined($_) && $_ ne '' } @_);
974            return '' unless defined($v);
975            return $v;
976    }
977    
978  =head1 AUTHOR  =head2 split_rec_on
979    
980  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  Split record subfield on some regex and take one of parts out
981    
982  =head1 COPYRIGHT & LICENSE    $a_before_semi_column =
983            split_rec_on('200','a', /\s*;\s*/, $part);
984    
985  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.  C<$part> is optional number of element. First element is
986    B<1>, not 0!
987    
988  This program is free software; you can redistribute it and/or modify it  If there is no C<$part> parameter or C<$part> is 0, this function will
989  under the same terms as Perl itself.  return all values produced by splitting.
990    
991  =cut  =cut
992    
993  1; # End of WebPAC::DB  sub split_rec_on {
994            die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
995    
996            my ($fld, $sf, $regex, $part) = @_;
997            warn "### regex ", ref($regex), $regex, $/ if ($debug > 2);
998    
999            my @r = rec( $fld, $sf );
1000            my $v = shift @r;
1001            warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
1002    
1003            return '' if ( ! defined($v) || $v =~ /^\s*$/);
1004    
1005            my @s = split( $regex, $v );
1006            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
1007            if ($part && $part > 0) {
1008                    return $s[ $part - 1 ];
1009            } else {
1010                    return @s;
1011            }
1012    }
1013    
1014    # END
1015    1;

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

  ViewVC Help
Powered by ViewVC 1.1.26