fingerprinter

   1 #!/usr/bin/perl
   2 use strict;
   3 use warnings;
   4 use open ':utf8';
   5
   6 use Getopt::Long;
   7 use MARC::Batch;
   8 use Unicode::Normalize;
   9 use MARC::File::XML ( BinaryEncoding => 'utf-8' );
  10
  11 my $conf  = {}; # configuration hashref
  12 my $count = 0; my $scount = 0;
  13 my $start = time;
  14 $| = 1;
  15
  16 initialize($conf);
  17
  18 open OF, '>', $conf->{output};
  19 open XF, '>', $conf->{exception};
  20
  21 for my $file (@ARGV) {
  22     print XF "Processing $file\n";
  23     my $batch = undef; my $record = undef;
  24
  25     $batch = MARC::Batch->new($conf->{marctype}, $file);
  26     $batch->strict_off();
  27     $batch->warnings_off();
  28
  29     while ( $record = $batch->next ) {
  30         $count++; progress_ticker();
  31         my $marc = undef;
  32         unless ( defined $record )
  33           { dump_exception($marc); next; }
  34
  35         my $id = $record->field($conf->{tag});
  36         unless ($id) {
  37             print XF "ERROR: Record $count in $file is missing a ",
  38               $conf->{tag}, " field.\n", $record->as_formatted(), "\n=====\n";
  39             next;
  40         }
  41
  42         # populate and normalize marc
  43         $marc = populate_marc($record, $id);
  44         normalize_marc($marc);
  45         unless (marc_isvalid($marc))
  46           { dump_exception($marc); next; }
  47
  48         # if everything looks good, score it and dump fingerprints
  49         score_marc($marc, $record);
  50         dump_fingerprints($marc);
  51         $scount++; progress_ticker();
  52     }
  53 }
  54
  55 print "\nSuccessfully processed:\t$count\n" unless $conf->{quiet};
  56
  57 =head2 populate_marc
  58
  59 Constructs a hash containing the relevant MARC data for a record and
  60 returns a reference to it.
  61
  62 =cut
  63
  64 sub populate_marc {
  65     my ($record, $id) = @_;
  66     my %marc = (); $marc{isbns} = [];
  67
  68     # id, stringified
  69     $marc{id} = $id->as_string($conf->{subfield});
  70
  71     # record_type, bib_lvl
  72     $marc{record_type} = substr($record->leader, 6, 1);
  73     $marc{bib_lvl}     = substr($record->leader, 7, 1);
  74
  75     # date1, date2
  76     my $my_008 = $record->field('008');
  77     $marc{tag008} = $my_008->as_string() if ($my_008);
  78     if (defined $marc{tag008}) {
  79         unless (length $marc{tag008} == 40) {
  80             $marc{tag008} = $marc{tag008} . ('|' x (40 - length($marc{tag008})));
  81             print XF ">> Short 008 padded to ",length($marc{tag008})," at rec $count\n";
  82         }
  83         $marc{date1} = substr($marc{tag008},7,4) if ($marc{tag008});
  84         $marc{date2} = substr($marc{tag008},11,4) if ($marc{tag008}); # UNUSED
  85     }
  86     unless ($marc{date1} and $marc{date1} =~ /\d{4}/) {
  87         my $my_260 = $record->field('260');
  88         my $date1 = $my_260->subfield('c') if $my_260;
  89         if (defined $date1 and $date1 =~ /\d{4}/) {
  90             $marc{date1} = $date1;
  91             $marc{fudgedate} = 1;
  92             print XF ">> using 260c as date1 at rec $count\n";
  93         }
  94     }
  95
  96     # item_form
  97     if ( $marc{record_type} =~ /[gkroef]/ ) { # MAP, VIS
  98         $marc{item_form} = substr($marc{tag008},29,1) if ($marc{tag008});
  99     } else {
 100         $marc{item_form} = substr($marc{tag008},23,1) if ($marc{tag008});
 101     }
 102
 103     # isbns
 104     my @isbns = $record->field('020') if $record->field('020');
 105     push @isbns, $record->field('024') if $record->field('024');
 106     for my $f ( @isbns ) {
 107         push @{ $marc{isbns} }, $1 if ( defined $f->subfield('a') and
 108                                         $f->subfield('a')=~/(\S+)/ );
 109     }
 110
 111     # author
 112     for my $rec_field (100, 110, 111) {
 113         if ($record->field($rec_field)) {
 114             $marc{author} = $record->field($rec_field)->subfield('a');
 115             last;
 116         }
 117     }
 118
 119     # oclc
 120     $marc{oclc} = [];
 121     push @{ $marc{oclc} }, $record->field('001')->as_string()
 122       if ($record->field('001') and $record->field('003') and
 123           $record->field('003')->as_string() =~ /OCo{0,1}LC/);
 124     for ($record->field('035')) {
 125         my $oclc = $_->subfield('a');
 126         push @{ $marc{oclc} }, $oclc
 127           if (defined $oclc and $oclc =~ /\(OCoLC\)/ and $oclc =~/([0-9]+)/);
 128     }
 129
 130     # "Accompanying material" and check for "copy" (300)
 131     if ($record->field('300')) {
 132         $marc{accomp} = $record->field('300')->subfield('e');
 133         $marc{tag300a} = $record->field('300')->subfield('a');
 134     }
 135
 136     # issn, lccn, title, desc, pages, pub, pubyear, edition
 137     $marc{lccn} = $record->field('010')->subfield('a') if $record->field('010');
 138     $marc{issn} = $record->field('022')->subfield('a') if $record->field('022');
 139     $marc{desc} = $record->field('300')->subfield('a') if $record->field('300');
 140     $marc{pages} = $1 if (defined $marc{desc} and $marc{desc} =~ /(\d+)/);
 141     $marc{title} = $record->field('245')->subfield('a')
 142       if $record->field('245');
 143     $marc{edition} = $record->field('250')->subfield('a')
 144       if $record->field('250');
 145     if ($record->field('260')) {
 146         $marc{publisher} = $record->field('260')->subfield('b');
 147         $marc{pubyear} = $record->field('260')->subfield('c');
 148         $marc{pubyear} =
 149           (defined $marc{pubyear} and $marc{pubyear} =~ /(\d{4})/) ? $1 : '';
 150     }
 151     return \%marc;
 152 }
 153
 154
 155
 156 =head2 normalize_marc
 157
 158 Gently massages your data.
 159
 160 =cut
 161
 162 sub normalize_marc {
 163     my ($marc) = @_;
 164
 165     $marc->{record_type }= 'a' if ($marc->{record_type} eq ' ');
 166     if ($marc->{title}) {
 167         $marc->{title} = NFD($marc->{title});
 168         $marc->{title} =~ s/[\x{80}-\x{ffff}]//go;
 169         $marc->{title} = lc($marc->{title});
 170         $marc->{title} =~ s/\W+$//go;
 171     }
 172     if ($marc->{author}) {
 173         $marc->{author} = NFD($marc->{author});
 174         $marc->{author} =~ s/[\x{80}-\x{ffff}]//go;
 175         $marc->{author} = lc($marc->{author});
 176         $marc->{author} =~ s/\W+$//go;
 177         if ($marc->{author} =~ /^(\w+)/) {
 178             $marc->{author} = $1;
 179         }
 180     }
 181     if ($marc->{publisher}) {
 182         $marc->{publisher} = NFD($marc->{publisher});
 183         $marc->{publisher} =~ s/[\x{80}-\x{ffff}]//go;
 184         $marc->{publisher} = lc($marc->{publisher});
 185         $marc->{publisher} =~ s/\W+$//go;
 186         if ($marc->{publisher} =~ /^(\w+)/) {
 187             $marc->{publisher} = $1;
 188         }
 189     }
 190     return $marc;
 191 }
 192
 193
 194
 195 =head2 marc_isvalid
 196
 197 Checks MARC record to see if neccessary fingerprinting data is
 198 available
 199
 200 =cut
 201
 202 sub marc_isvalid {
 203     my ($marc) = @_;
 204     return 1 if ($marc->{item_form} and ($marc->{date1} =~ /\d{4}/) and
 205                  $marc->{record_type} and $marc->{bib_lvl} and $marc->{title});
 206     return 0;
 207 }
 208
 209
 210 =head2 score_marc
 211
 212 Assign a score to the record based on various criteria.
 213
 214 Score is constructed by pushing elements onto a list, via a dispatch
 215 table.  This allows order of fingerprints in the output file to be
 216 varied.
 217
 218 =cut
 219
 220 sub score_marc {
 221     my ($marc, $record) = @_;
 222     my @score = ();
 223     my $json = '{';
 224
 225     #----------------------------------
 226     # static criteria scoring
 227     #----------------------------------
 228     $marc->{misc_score} = 999999999999;
 229     # subtract record id if we want older records to win
 230     $marc->{misc_score} -= $marc->{id} unless ($conf->{newwins});
 231     # handle arbitrary adjustments
 232     if ($conf->{'arbitrarily-decrease-score-above'}) {
 233         $marc->{misc_score} -= $conf->{'arbitrarily-decrease-score-by'}
 234           if ($marc->{id} >= $conf->{'arbitrarily-decrease-score-above'});
 235     }
 236     if ($conf->{'arbitrarily-decrease-score-below'}) {
 237         $marc->{misc_score} -= $conf->{'arbitrarily-decrease-score-by'}
 238           if ($marc->{id} <= $conf->{'arbitrarily-decrease-score-below'});
 239     }
 240     # -1 if 008 has been padded, -2 if it doesn't exist
 241     if ($marc->{tag008})
 242       { $marc->{misc_score}-- if ($marc->{tag008} =~ /\|$/) }
 243     else
 244       { $marc->{misc_score} -= 2 }
 245     # -1 if date has been pulled from 260
 246     $marc->{misc_score}-- if $marc->{fudgedate};
 247     # -1 if this is a copy record
 248     $marc->{misc_score}--
 249       if (defined $marc->{tag300a} and $marc->{tag300a} =~ /copy/i);
 250
 251     #----------------------------------
 252     # dynamic calculated scoring
 253     #----------------------------------
 254     my %scores_code = (
 255       oclc    => sub { return $marc->{oclc}[0] ? 1 : 0 },
 256       dlc     => sub {
 257           if ($record->field('040') and $record->field('040')->subfield('a'))
 258             { return scalar($record->subfield( '040', 'a')) =~ /dlc/io ? 1 : 0 }
 259           else { return 0 }
 260       },
 261       num_650 => sub {
 262           if ($record->field('650')) {
 263               # can't say "scalar $record->field('650')"; MARC::Record
 264               # behaves differently in list/scalar contexts
 265               my @tags = $record->field('650');
 266               return sprintf("%04d", scalar @tags)
 267           } else { return '0000' }
 268       },
 269       num_tags=> sub { return sprintf( '%04d', scalar( $record->fields ) ) },
 270       enc_lvl => sub {
 271         my $enc = substr($record->leader, 17, 1) || 'u';
 272         my %levels = ( ' ' => 9, 1 => 8, 2 => 7,  3  => 6,  4  => 5, 5 => 4,
 273                        6   => 3, 7 => 2, 8 => 1, 'u' => 0, 'z' => 0 );
 274         return $levels{$enc} || 0;
 275     }
 276                       );
 277
 278     #----------------------------------
 279     # assemble and store scores
 280     #----------------------------------
 281     for ( @{ $conf->{dyn_scores} } ) {
 282         push @score, $scores_code{$_}->($marc, $record);
 283         $json .= $_ . ':' . $score[-1] . ',';
 284     }
 285     $json .= 'misc:' . $marc->{misc_score} . '}';
 286
 287     my $compact = join('', $marc->{misc_score}, @score);
 288     $marc->{score} = "$compact\t$json";
 289 }
 290
 291 =head2 dump_fingerprints
 292
 293 =cut
 294
 295 sub dump_fingerprints {
 296     my ($marc) = @_;
 297
 298     if ($conf->{fingerprints}{baseline}) {
 299         print OF join("\t", $marc->{score}, $marc->{id}, 'baseline',
 300                       $marc->{item_form}, $marc->{date1}, $marc->{record_type},
 301                       $marc->{bib_lvl}, $marc->{title}), "\n";
 302     }
 303
 304     if ($conf->{fingerprints}{oclc} and scalar @{$marc->{oclc} }) {
 305         for (@{$marc->{oclc} }) {
 306             print OF join("\t", $marc->{score}, $marc->{id}, "oclc",
 307                           $marc->{item_form}, $marc->{date1},
 308                           $marc->{record_type}, $marc->{bib_lvl},
 309                           $marc->{title}, $_, "\n");
 310         }
 311     }
 312
 313     if ($conf->{fingerprints}{isbn}) {
 314         if ((scalar @{ $marc->{isbns} } > 0) and $marc->{pages}) {
 315             foreach my $isbn ( @{ $marc->{isbns}} ) {
 316                 print OF join("\t", $marc->{score}, $marc->{id}, "isbn",
 317                               $marc->{item_form}, $marc->{date1},
 318                               $marc->{record_type},
 319                               $marc->{bib_lvl}, $marc->{title},
 320                               $isbn, $marc->{pages}), "\n";
 321             }
 322         }
 323     }
 324
 325     if ($conf->{fingerprints}{edition} and $marc->{edition}) {
 326         print OF join("\t", $marc->{score}, $marc->{id}, "edition",
 327                       $marc->{item_form}, $marc->{date1},
 328                       $marc->{record_type}, $marc->{bib_lvl},
 329                       $marc->{title}, $marc->{edition}), "\n";
 330     }
 331
 332     if ($conf->{fingerprints}{issn} and $marc->{issn}) {
 333         print OF join("\t", $marc->{score}, $marc->{id}, "issn",
 334                       $marc->{item_form}, $marc->{date1},
 335                       $marc->{record_type}, $marc->{bib_lvl},
 336                       $marc->{title}, $marc->{issn}), "\n";
 337     }
 338
 339     if ($conf->{fingerprints}{lccn} and $marc->{lccn}) {
 340         print OF join("\t", $marc->{score}, $marc->{id}, "lccn",
 341                       $marc->{item_form}, $marc->{date1},
 342                       $marc->{record_type}, $marc->{bib_lvl},
 343                       $marc->{title}, $marc->{lccn}) ,"\n";
 344     }
 345
 346     if ($conf->{fingerprints}{accomp} and $marc->{accomp}) {
 347         print OF join("\t", $marc->{score}, $marc->{id}, "accomp",
 348                       $marc->{item_form}, $marc->{date1},
 349                       $marc->{record_type}, $marc->{bib_lvl},
 350                       $marc->{title}, $marc->{accomp}) ,"\n";
 351     }
 352
 353     if ($conf->{fingerprints}{authpub} and $marc->{author} and
 354         $marc->{publisher} and $marc->{pubyear} and $marc->{pages}) {
 355         print OF join("\t", $marc->{score}, $marc->{id}, "authpub",
 356                       $marc->{item_form}, $marc->{date1},
 357                       $marc->{record_type}, $marc->{bib_lvl},
 358                       $marc->{title}, $marc->{author},
 359                       $marc->{publisher}, $marc->{pubyear},
 360                       $marc->{pages}), "\n";
 361     }
 362 }
 363
 364
 365
 366 =head2 dump_exception
 367
 368 Write line of exception report
 369
 370 =cut
 371
 372 sub dump_exception {
 373     my ($marc) = @_;
 374     unless (defined $marc) {
 375         print XF "Undefined record at line $count; likely bad XML\n";
 376         return;
 377     }
 378     print XF "Record ", $marc->{id}, " excluded: ";
 379     print XF "missing item_form; " unless ($marc->{item_form});
 380     unless (defined $marc->{date1})
 381       { print XF "missing date1; " }
 382     else
 383       { print XF "invalid date1: '", $marc->{date1}, "'; "
 384           unless ($marc->{date1} =~ /\d{4}/); }
 385     print XF "missing record_type; " unless ($marc->{record_type});
 386     print XF "missing bib_lvl; " unless ($marc->{bib_lvl});
 387     print XF "missing title " unless ($marc->{title});
 388     print XF "\n";
 389 }
 390
 391
 392 =head2 initialize
 393
 394 Performs boring script initialization. Handles argument parsing,
 395 mostly.
 396
 397 =cut
 398
 399 sub initialize {
 400     my ($c) = @_;
 401     my @missing = ();
 402
 403     # set mode on existing filehandles
 404     binmode(STDIN, ':utf8');
 405
 406     my $rc = GetOptions( $c,
 407                          'exception|x=s',
 408                          'output|o=s',
 409                          'prefix|p=s',
 410                          'marctype|m=s',
 411                          'subfield|s=s',
 412                          'tag|t=s',
 413                          'fingerprints=s',
 414                          'scores=s',
 415                          'arbitrarily-decrease-score-above=i',
 416                          'arbitrarily-decrease-score-below=i',
 417                          'arbitrarily-decrease-score-by=i',
 418                          'newwins',
 419                          'quiet|q',
 420                          'help|h',
 421                        );
 422     show_help() unless $rc;
 423     show_help() if ($c->{help});
 424
 425     # check fingerprints list for validity
 426     if ($c->{fingerprints}) {
 427         my %fps = ();
 428         my %valid_fps = ( oclc => 1, isbn => 1, issn => 1, lccn => 1,
 429                           edition => 1, accomp => 1, authpub => 1,
 430                           baseline => 1, crap => 1,
 431                         );
 432         for (split /,/, $c->{fingerprints}) {
 433             die "Invalid fingerprint '$_'\n" unless $valid_fps{$_};
 434             $fps{$_} = 1;
 435         }
 436         $c->{fingerprints} = \%fps
 437     } else {
 438         $c->{fingerprints} = {oclc => 1, isbn => 1, edition => 1, issn => 1,
 439                               lccn => 1, accomp => 1, authpub => 1};
 440     }
 441
 442     # check scores list for validity
 443     if ($c->{scores}) {
 444         my %scores = ();
 445         my %valid_scores = ( oclc => 1, dlc => 1, num_650 => 1,
 446                              num_tags => 1, enc_lvl => 1,
 447                            );
 448         for (split /,/, $c->{scores}) {
 449             die "Invalid score mode '$_'\n" unless $valid_scores{$_};
 450             $scores{$_} = 1;
 451         }
 452         $c->{dyn_scores} = [split /,/, $c->{scores}];
 453         $c->{scores} = \%scores;
 454     } else {
 455         $c->{scores} = {oclc => 1, dlc => 1, num_650 => 1,
 456                         num_tags => 1, enc_lvl => 1};
 457         $c->{dyn_scores} = [ qw/oclc dlc num_650 num_tags enc_lvl/ ];
 458     }
 459
 460     # set defaults
 461     $c->{tag} = 903 unless defined $c->{tag};
 462     $c->{subfield} = 'a' unless defined $c->{subfield};
 463     $c->{marctype} = 'XML' unless defined $c->{marctype};
 464     $c->{'arbitrarily-decrease-score-by'} = 0
 465       unless defined $c->{'arbitrarily-decrease-score-by'};
 466     if ($c->{prefix}) {
 467         $c->{output} = join('.',$c->{prefix},'fp');
 468         $c->{exception} = join('.',$c->{prefix},'fp','ex');
 469     }
 470
 471     my @keys = keys %{$c};
 472     show_help() unless (@ARGV and @keys);
 473     for my $key ('tag', 'subfield', 'output', 'exception')
 474       { push @missing, $key unless $c->{$key} }
 475     if (@missing) {
 476         print "Required option: ", join(', ', @missing), " missing!\n";
 477         show_help();
 478     }
 479 }
 480
 481
 482 =head2 progress_ticker
 483
 484 =cut
 485
 486 sub progress_ticker {
 487     return if $conf->{quiet};
 488     printf("\r> %d recs seen; %d processed", $count, $scount);
 489     printf(" (%d/s)", ($count / (time - $start + 1)))
 490       if ($count % 500 == 0);
 491 }
 492
 493 =head2 show_help
 494
 495 Display usage message when things go wrong
 496
 497 =cut
 498
 499 sub show_help {
 500 print <<HELP;
 501 Usage is: $0 [REQUIRED ARGS] [OPTIONS] <filelist>
 502 Req'd Arguments
 503   --output=<FILE>      -o  Output filename
 504   --exceptions=<FILE>  -x  Exception report filename
 505        or
 506   --prefix=<PREFIX>>   -p  Shared prefix for output/exception files. Will
 507                            produce PREFIX.fp and PREFIX.fp.ex
 508 Options
 509   --tag=N       -t  Which tag to use (default 903)
 510   --subfield=X  -s  Which subfield to use (default 'a')
 511   --quiet       -q  Don't write status messages to STDOUT
 512
 513   --fingerprints=LIST  Fingerprints to generate, comma separated
 514                        Default: oclc,isbn,edition,issn,lccn,accomp,authpub
 515                        Others:  baseline
 516
 517   --scores=LIST  Scores to calculate, comma separated
 518                  Default: oclc,dlc,num_650,num_tags,enc_level
 519   --newwins      New record IDs score higher (default is old wins)
 520   --arbitrarily-decrease-score-above
 521   --arbitrarily-decrease-score-below
 522   --arbitrarily-decrease-score-by
 523       Modify fingerprint scoring of records whose EG id is above or below a
 524       given value, inclusive (so 5 is <= 5 or >= 5). -by gives the amount by
 525       which to adjust the score.
 526
 527   --marctype=TYPE Defaults to 'XML'
 528 HELP
 529 exit 1;
 530 }