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

Legend:
Removed from v.18  
changed lines
  Added in v.1373

  ViewVC Help
Powered by ViewVC 1.1.26