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

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

  ViewVC Help
Powered by ViewVC 1.1.26