fix typos in table names
[migration-tools.git] / fingerprinter
index c0a8741..f388174 100755 (executable)
@@ -1,4 +1,21 @@
 #!/usr/bin/perl
+
+# Copyright 2009-2012, Equinox Software, Inc.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
 use strict;
 use warnings;
 use open ':utf8';
@@ -7,6 +24,8 @@ use Getopt::Long;
 use MARC::Batch;
 use Unicode::Normalize;
 use MARC::File::XML ( BinaryEncoding => 'utf-8' );
+use Equinox::Migration::SubfieldMapper;
+use Equinox::Migration::Utils qw/normalize_oclc_number/;
 
 my $conf  = {}; # configuration hashref
 my $count = 0; my $scount = 0;
@@ -15,18 +34,25 @@ $| = 1;
 
 initialize($conf);
 
-open OF, '>', $conf->{output};
-open XF, '>', $conf->{exception};
+open OF, '>', $conf->{output} or die "$0: cannot open output file $conf->{output}: $!\n";
+open XF, '>', $conf->{exception} or die "$0: cannot open exception file $conf->{exception}: $!\n";
 
 for my $file (@ARGV) {
     print XF "Processing $file\n";
-    my $batch = undef; my $record = undef;
 
-    $batch = MARC::Batch->new($conf->{marctype}, $file);
+    my $batch = MARC::Batch->new($conf->{marctype}, $file);
     $batch->strict_off();
     $batch->warnings_off();
 
-    while ( $record = $batch->next ) {
+    my $record;
+    while ( 1 ) {
+        eval { $record = $batch->next; };
+        if ($@) {
+            import MARC::File::XML;
+            print "skipping bad record: $@\n";
+            next;
+        }
+        last unless $record;
         $count++; progress_ticker();
         my $marc = undef;
         unless ( defined $record )
@@ -41,6 +67,8 @@ for my $file (@ARGV) {
 
         # populate and normalize marc
         $marc = populate_marc($record, $id);
+        # check for manual exclusion
+        next if this_record_is_excluded($record, $marc);
         normalize_marc($marc);
         unless (marc_isvalid($marc))
           { dump_exception($marc); next; }
@@ -74,7 +102,7 @@ sub populate_marc {
 
     # date1, date2
     my $my_008 = $record->field('008');
-    $marc{tag008} = $my_008->as_string();# if ($my_008);
+    $marc{tag008} = $my_008->as_string() if ($my_008);
     if (defined $marc{tag008}) {
         unless (length $marc{tag008} == 40) {
             $marc{tag008} = $marc{tag008} . ('|' x (40 - length($marc{tag008})));
@@ -85,11 +113,14 @@ sub populate_marc {
     }
     unless ($marc{date1} and $marc{date1} =~ /\d{4}/) {
         my $my_260 = $record->field('260');
-        my $date1 = $my_260->subfield('c') if $my_260;
-        if (defined $date1 and $date1 =~ /\d{4}/) {
-            $marc{date1} = $date1;
-            $marc{fudgedate} = 1;
-            print XF ">> using 260c as date1 at rec $count\n";
+        if ($my_260 and $my_260->subfield('c')) {
+            my $date1 = $my_260->subfield('c');
+            $date1 =~ s/\D//g;
+            if (defined $date1 and $date1 =~ /\d{4}/) {
+                $marc{date1} = $date1;
+                $marc{fudgedate} = 1;
+                print XF ">> using 260c as date1 at rec $count\n";
+            }
         }
     }
 
@@ -118,13 +149,24 @@ sub populate_marc {
 
     # oclc
     $marc{oclc} = [];
-    push @{ $marc{oclc} }, $record->field('001')->as_string()
-      if ($record->field('001') and $record->field('003') and
-          $record->field('003')->as_string() =~ /OCo{0,1}LC/);
+    if ($record->field('001') &&
+        $record->field('003') &&
+        $record->field('003')->as_string() =~ /OCo{0,1}LC/ &&
+        defined normalize_oclc_number($record->field('001')->as_string())) {
+        push @{ $marc{oclc} }, normalize_oclc_number($record->field('001')->as_string());
+    }
     for ($record->field('035')) {
         my $oclc = $_->subfield('a');
-        push @{ $marc{oclc} }, $oclc
-          if (defined $oclc and $oclc =~ /\(OCoLC\)/ and $oclc =~/([0-9]+)/);
+        if (defined $oclc &&
+            ($oclc =~ /\(OCoLC\)/ || $oclc =~ /(ocm|ocl7|ocn|on)/) &&
+            defined normalize_oclc_number($oclc)) {
+            push @{ $marc{oclc} }, normalize_oclc_number($oclc);
+        }
+    }
+
+    if ($record->field('999')) {
+        my $koha_bib_id = $record->field('999')->subfield('c');
+        $marc{koha_bib_id} = $koha_bib_id if defined $koha_bib_id and $koha_bib_id =~ /^\d+$/;
     }
 
     # "Accompanying material" and check for "copy" (300)
@@ -140,6 +182,10 @@ sub populate_marc {
     $marc{pages} = $1 if (defined $marc{desc} and $marc{desc} =~ /(\d+)/);
     $marc{title} = $record->field('245')->subfield('a')
       if $record->field('245');
+    $marc{title} .= ' ' . $record->field('245')->subfield('b')
+      if ($record->field('245') and 
+          $record->field('245')->subfield('b') and 
+          not $conf->{ignoresubtitle});
     $marc{edition} = $record->field('250')->subfield('a')
       if $record->field('250');
     if ($record->field('260')) {
@@ -226,6 +272,8 @@ sub score_marc {
     # static criteria scoring
     #----------------------------------
     $marc->{misc_score} = 999;
+    $marc->{age_score}  = 999999999999;
+
     # -1 if 008 has been padded, -2 if it doesn't exist
     if ($marc->{tag008})
       { $marc->{misc_score}-- if ($marc->{tag008} =~ /\|$/) }
@@ -237,6 +285,19 @@ sub score_marc {
     $marc->{misc_score}--
       if (defined $marc->{tag300a} and $marc->{tag300a} =~ /copy/i);
 
+    # subtract record id if we want older records to win
+    #$marc->{age_score} -= $marc->{id} unless ($conf->{newwins});
+    # handle arbitrary adjustments
+    $marc->{age_score} = 1;
+    if ($conf->{'arbitrarily-lose-above'}) {
+        $marc->{age_score} = 0
+          if ($marc->{id} >= $conf->{'arbitrarily-lose-above'});
+    }
+    if ($conf->{'arbitrarily-lose-below'}) {
+        $marc->{age_score} = 0
+          if ($marc->{id} <= $conf->{'arbitrarily-lose-below'});
+    }
+
     #----------------------------------
     # dynamic calculated scoring
     #----------------------------------
@@ -273,7 +334,7 @@ sub score_marc {
     }
     $json .= 'misc:' . $marc->{misc_score} . '}';
 
-    my $compact = join('', $marc->{misc_score}, @score);
+    my $compact = join('', $marc->{age_score}, $marc->{misc_score}, @score);
     $marc->{score} = "$compact\t$json";
 }
 
@@ -299,6 +360,14 @@ sub dump_fingerprints {
         }
     }
 
+    if ($conf->{fingerprints}{koha_bib_id} and exists $marc->{koha_bib_id}) {
+        print OF join("\t", $marc->{score}, $marc->{id}, "z_koha_bib_id",
+                      $marc->{item_form}, $marc->{date1},
+                      $marc->{record_type},
+                      $marc->{bib_lvl}, $marc->{title},
+                      $marc->{koha_bib_id}), "\n";
+    }
+
     if ($conf->{fingerprints}{isbn}) {
         if ((scalar @{ $marc->{isbns} } > 0) and $marc->{pages}) {
             foreach my $isbn ( @{ $marc->{isbns}} ) {
@@ -311,11 +380,11 @@ sub dump_fingerprints {
         }
     }
 
-    if ($conf->{fingerprints}{edition} and $marc->{edition}) {
+    if ($conf->{fingerprints}{edition} and $marc->{edition} and $marc->{author}) {
         print OF join("\t", $marc->{score}, $marc->{id}, "edition",
                       $marc->{item_form}, $marc->{date1},
                       $marc->{record_type}, $marc->{bib_lvl},
-                      $marc->{title}, $marc->{edition}), "\n";
+                      $marc->{title}, $marc->{author}, $marc->{edition}), "\n";
     }
 
     if ($conf->{fingerprints}{issn} and $marc->{issn}) {
@@ -359,25 +428,67 @@ Write line of exception report
 =cut
 
 sub dump_exception {
-    my ($marc) = @_;
+    my ($marc, $msg) = @_;
     unless (defined $marc) {
         print XF "Undefined record at line $count; likely bad XML\n";
         return;
     }
-    print XF "Record ", $marc->{id}, " did not make the cut: ";
-    print XF "Missing item_form. " unless ($marc->{item_form});
+
+    print XF "Record ", $marc->{id}, " excluded: ";
+    if (defined $msg) {
+        print XF "$msg\n";
+        return
+    }
+
+    print XF "missing item_form; " unless ($marc->{item_form});
     unless (defined $marc->{date1})
-      { print XF "Missing date1. " }
+      { print XF "missing date1; " }
     else
-      { print XF "Invalid date1: ", $marc->{date1}, " "
+      { print XF "invalid date1: '", $marc->{date1}, "'; "
           unless ($marc->{date1} =~ /\d{4}/); }
-    print XF "Missing record_type. " unless ($marc->{record_type});
-    print XF "Missing bib_lvl. " unless ($marc->{bib_lvl});
-    print XF "Missing title. " unless ($marc->{title});
+    print XF "missing record_type; " unless ($marc->{record_type});
+    print XF "missing bib_lvl; " unless ($marc->{bib_lvl});
+    print XF "missing title " unless ($marc->{title});
     print XF "\n";
 }
 
 
+=head2 this_record_is_excluded
+
+Returns 1 if the record B<is> and 0 if the record B<is not> excluded,
+according to the subfield mapping (generated via the C<--excludelist>
+option).
+
+=cut
+
+sub this_record_is_excluded {
+    my ($rec, $marc) = @_;
+    return 0 unless defined $conf->{excludelist};
+
+    for my $tag (keys %{ $conf->{excludelist}->{tags} }) {
+        for my $sub (keys %{$conf->{excludelist}->{tags}{$tag}}) {
+            my $f = $conf->{excludelist}->field($tag, $sub);
+
+            # if this record doesn't have the right tag/sub, it can't be
+            return 0 unless ($rec->field($tag) and $rec->field($tag)->subfield($sub));
+            # but it does, so if there are no filters to check...
+            unless ($conf->{excludelist}->filters($f))
+              { dump_exception($marc, "exclusion $tag$sub"); return 1 }
+
+            my $sub_contents = $rec->field($tag)->subfield($sub);
+            for my $filter (@{ $conf->{excludelist}->filters($f)}) {
+                if ($sub_contents =~ /$filter/i) {
+                    # filter matches. no fp.
+                    dump_exception($marc, "exclusion $tag$sub '$filter'");
+                    return 1;
+                }
+                # no match, no exclude
+                return 0;
+            }
+        }
+    }
+}
+
 =head2 initialize
 
 Performs boring script initialization. Handles argument parsing,
@@ -401,6 +512,11 @@ sub initialize {
                          'tag|t=s',
                          'fingerprints=s',
                          'scores=s',
+                         'arbitrarily-lose-above=i',
+                         'arbitrarily-lose-below=i',
+                         'newwins',
+                         'excludelist=s',
+                         'ignoresubtitle|i',
                          'quiet|q',
                          'help|h',
                        );
@@ -413,6 +529,7 @@ sub initialize {
         my %valid_fps = ( oclc => 1, isbn => 1, issn => 1, lccn => 1,
                           edition => 1, accomp => 1, authpub => 1,
                           baseline => 1, crap => 1,
+                          koha_bib_id => 1,
                         );
         for (split /,/, $c->{fingerprints}) {
             die "Invalid fingerprint '$_'\n" unless $valid_fps{$_};
@@ -451,6 +568,12 @@ sub initialize {
         $c->{exception} = join('.',$c->{prefix},'fp','ex');
     }
 
+    # get SFM object if excludelist was specified
+    if ($c->{excludelist}) {
+        $c->{excludelist} =
+          Equinox::Migration::SubfieldMapper->new( file => $c->{excludelist} );
+    }
+
     my @keys = keys %{$c};
     show_help() unless (@ARGV and @keys);
     for my $key ('tag', 'subfield', 'output', 'exception')
@@ -489,16 +612,24 @@ Req'd Arguments
   --prefix=<PREFIX>>   -p  Shared prefix for output/exception files. Will
                            produce PREFIX.fp and PREFIX.fp.ex
 Options
-  --tag=N       -t  Which tag to use (default 903)
-  --subfield=X  -s  Which subfield to use (default 'a')
-  --quiet       -q  Don't write status messages to STDOUT
+  --tag=N           -t  Which tag to use (default 903)
+  --subfield=X      -s  Which subfield to use (default 'a')
+  --quiet           -q  Don't write status messages to STDOUT
+  --ignoresubtitle  -i  Ignore 245\$b and construct the title from 245\$a alone.
 
   --fingerprints=LIST  Fingerprints to generate, comma separated
                        Default: oclc,isbn,edition,issn,lccn,accomp,authpub
-                       Others:  baseline
+                       Others:  baseline,koha_bib_id
+  --excludelist=FILE   Name of fingerprints exclusions file
 
   --scores=LIST  Scores to calculate, comma separated
                  Default: oclc,dlc,num_650,num_tags,enc_level
+  --newwins      New record IDs score higher (default is old wins)
+  --arbitrarily-lose-above
+  --arbitrarily-lose-below
+  --arbitrarily-decrease-score-by
+      Modify fingerprint scoring of records whose EG id is above or below a
+      given value, inclusive (so 5 is <= 5 or >= 5) such that they lose.
 
   --marctype=TYPE Defaults to 'XML'
 HELP