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

Legend:
Removed from v.22  
changed lines
  Added in v.1210

  ViewVC Help
Powered by ViewVC 1.1.26