8 use Unicode::Normalize;
9 use MARC::File::XML ( BinaryEncoding => 'utf-8' );
11 my $conf = {}; # configuration hashref
12 my $count = 0; my $scount = 0;
18 open OF, '>', $conf->{output};
19 open XF, '>', $conf->{exception};
21 for my $file (@ARGV) {
22 print XF "Processing $file\n";
23 my $batch = undef; my $record = undef;
25 $batch = MARC::Batch->new($conf->{marctype}, $file);
27 $batch->warnings_off();
29 while ( $record = $batch->next ) {
30 $count++; progress_ticker();
32 unless ( defined $record )
33 { dump_exception($marc); next; }
35 my $id = $record->field($conf->{tag});
37 print XF "ERROR: Record $count in $file is missing a ",
38 $conf->{tag}, " field.\n", $record->as_formatted(), "\n=====\n";
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; }
48 # if everything looks good, score it and dump fingerprints
49 score_marc($marc, $record);
50 dump_fingerprints($marc);
51 $scount++; progress_ticker();
55 print "\nSuccessfully processed:\t$count\n" unless $conf->{quiet};
59 Constructs a hash containing the relevant MARC data for a record and
60 returns a reference to it.
65 my ($record, $id) = @_;
66 my %marc = (); $marc{isbns} = [];
69 $marc{id} = $id->as_string($conf->{subfield});
71 # record_type, bib_lvl
72 $marc{record_type} = substr($record->leader, 6, 1);
73 $marc{bib_lvl} = substr($record->leader, 7, 1);
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";
83 $marc{date1} = substr($marc{tag008},7,4) if ($marc{tag008});
84 $marc{date2} = substr($marc{tag008},11,4) if ($marc{tag008}); # UNUSED
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;
92 print XF ">> using 260c as date1 at rec $count\n";
97 if ( $marc{record_type} =~ /[gkroef]/ ) { # MAP, VIS
98 $marc{item_form} = substr($marc{tag008},29,1) if ($marc{tag008});
100 $marc{item_form} = substr($marc{tag008},23,1) if ($marc{tag008});
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+)/ );
112 for my $rec_field (100, 110, 111) {
113 if ($record->field($rec_field)) {
114 $marc{author} = $record->field($rec_field)->subfield('a');
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]+)/);
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');
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');
149 (defined $marc{pubyear} and $marc{pubyear} =~ /(\d{4})/) ? $1 : '';
156 =head2 normalize_marc
158 Gently massages your data.
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;
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;
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;
197 Checks MARC record to see if neccessary fingerprinting data is
204 return 1 if ($marc->{item_form} and ($marc->{date1} =~ /\d{4}/) and
205 $marc->{record_type} and $marc->{bib_lvl} and $marc->{title});
212 Assign a score to the record based on various criteria.
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
221 my ($marc, $record) = @_;
225 #----------------------------------
226 # static criteria scoring
227 #----------------------------------
228 $marc->{misc_score} = 999;
229 $marc->{age_score} = 999999999999;
231 # -1 if 008 has been padded, -2 if it doesn't exist
233 { $marc->{misc_score}-- if ($marc->{tag008} =~ /\|$/) }
235 { $marc->{misc_score} -= 2 }
236 # -1 if date has been pulled from 260
237 $marc->{misc_score}-- if $marc->{fudgedate};
238 # -1 if this is a copy record
239 $marc->{misc_score}--
240 if (defined $marc->{tag300a} and $marc->{tag300a} =~ /copy/i);
242 # subtract record id if we want older records to win
243 $marc->{age_score} -= $marc->{id} unless ($conf->{newwins});
244 # handle arbitrary adjustments
245 if ($conf->{'arbitrarily-decrease-score-above'}) {
246 $marc->{age_score} -= $conf->{'arbitrarily-decrease-score-by'}
247 if ($marc->{id} >= $conf->{'arbitrarily-decrease-score-above'});
249 if ($conf->{'arbitrarily-decrease-score-below'}) {
250 $marc->{age_score} -= $conf->{'arbitrarily-decrease-score-by'}
251 if ($marc->{id} <= $conf->{'arbitrarily-decrease-score-below'});
254 #----------------------------------
255 # dynamic calculated scoring
256 #----------------------------------
258 oclc => sub { return $marc->{oclc}[0] ? 1 : 0 },
260 if ($record->field('040') and $record->field('040')->subfield('a'))
261 { return scalar($record->subfield( '040', 'a')) =~ /dlc/io ? 1 : 0 }
265 if ($record->field('650')) {
266 # can't say "scalar $record->field('650')"; MARC::Record
267 # behaves differently in list/scalar contexts
268 my @tags = $record->field('650');
269 return sprintf("%04d", scalar @tags)
270 } else { return '0000' }
272 num_tags=> sub { return sprintf( '%04d', scalar( $record->fields ) ) },
274 my $enc = substr($record->leader, 17, 1) || 'u';
275 my %levels = ( ' ' => 9, 1 => 8, 2 => 7, 3 => 6, 4 => 5, 5 => 4,
276 6 => 3, 7 => 2, 8 => 1, 'u' => 0, 'z' => 0 );
277 return $levels{$enc} || 0;
281 #----------------------------------
282 # assemble and store scores
283 #----------------------------------
284 for ( @{ $conf->{dyn_scores} } ) {
285 push @score, $scores_code{$_}->($marc, $record);
286 $json .= $_ . ':' . $score[-1] . ',';
288 $json .= 'misc:' . $marc->{misc_score} . '}';
290 my $compact = join('', $marc->{misc_score}, @score, $marc->{age_score});
291 $marc->{score} = "$compact\t$json";
294 =head2 dump_fingerprints
298 sub dump_fingerprints {
301 if ($conf->{fingerprints}{baseline}) {
302 print OF join("\t", $marc->{score}, $marc->{id}, 'baseline',
303 $marc->{item_form}, $marc->{date1}, $marc->{record_type},
304 $marc->{bib_lvl}, $marc->{title}), "\n";
307 if ($conf->{fingerprints}{oclc} and scalar @{$marc->{oclc} }) {
308 for (@{$marc->{oclc} }) {
309 print OF join("\t", $marc->{score}, $marc->{id}, "oclc",
310 $marc->{item_form}, $marc->{date1},
311 $marc->{record_type}, $marc->{bib_lvl},
312 $marc->{title}, $_, "\n");
316 if ($conf->{fingerprints}{isbn}) {
317 if ((scalar @{ $marc->{isbns} } > 0) and $marc->{pages}) {
318 foreach my $isbn ( @{ $marc->{isbns}} ) {
319 print OF join("\t", $marc->{score}, $marc->{id}, "isbn",
320 $marc->{item_form}, $marc->{date1},
321 $marc->{record_type},
322 $marc->{bib_lvl}, $marc->{title},
323 $isbn, $marc->{pages}), "\n";
328 if ($conf->{fingerprints}{edition} and $marc->{edition}) {
329 print OF join("\t", $marc->{score}, $marc->{id}, "edition",
330 $marc->{item_form}, $marc->{date1},
331 $marc->{record_type}, $marc->{bib_lvl},
332 $marc->{title}, $marc->{edition}), "\n";
335 if ($conf->{fingerprints}{issn} and $marc->{issn}) {
336 print OF join("\t", $marc->{score}, $marc->{id}, "issn",
337 $marc->{item_form}, $marc->{date1},
338 $marc->{record_type}, $marc->{bib_lvl},
339 $marc->{title}, $marc->{issn}), "\n";
342 if ($conf->{fingerprints}{lccn} and $marc->{lccn}) {
343 print OF join("\t", $marc->{score}, $marc->{id}, "lccn",
344 $marc->{item_form}, $marc->{date1},
345 $marc->{record_type}, $marc->{bib_lvl},
346 $marc->{title}, $marc->{lccn}) ,"\n";
349 if ($conf->{fingerprints}{accomp} and $marc->{accomp}) {
350 print OF join("\t", $marc->{score}, $marc->{id}, "accomp",
351 $marc->{item_form}, $marc->{date1},
352 $marc->{record_type}, $marc->{bib_lvl},
353 $marc->{title}, $marc->{accomp}) ,"\n";
356 if ($conf->{fingerprints}{authpub} and $marc->{author} and
357 $marc->{publisher} and $marc->{pubyear} and $marc->{pages}) {
358 print OF join("\t", $marc->{score}, $marc->{id}, "authpub",
359 $marc->{item_form}, $marc->{date1},
360 $marc->{record_type}, $marc->{bib_lvl},
361 $marc->{title}, $marc->{author},
362 $marc->{publisher}, $marc->{pubyear},
363 $marc->{pages}), "\n";
369 =head2 dump_exception
371 Write line of exception report
377 unless (defined $marc) {
378 print XF "Undefined record at line $count; likely bad XML\n";
381 print XF "Record ", $marc->{id}, " excluded: ";
382 print XF "missing item_form; " unless ($marc->{item_form});
383 unless (defined $marc->{date1})
384 { print XF "missing date1; " }
386 { print XF "invalid date1: '", $marc->{date1}, "'; "
387 unless ($marc->{date1} =~ /\d{4}/); }
388 print XF "missing record_type; " unless ($marc->{record_type});
389 print XF "missing bib_lvl; " unless ($marc->{bib_lvl});
390 print XF "missing title " unless ($marc->{title});
397 Performs boring script initialization. Handles argument parsing,
406 # set mode on existing filehandles
407 binmode(STDIN, ':utf8');
409 my $rc = GetOptions( $c,
418 'arbitrarily-decrease-score-above=i',
419 'arbitrarily-decrease-score-below=i',
420 'arbitrarily-decrease-score-by=i',
425 show_help() unless $rc;
426 show_help() if ($c->{help});
428 # check fingerprints list for validity
429 if ($c->{fingerprints}) {
431 my %valid_fps = ( oclc => 1, isbn => 1, issn => 1, lccn => 1,
432 edition => 1, accomp => 1, authpub => 1,
433 baseline => 1, crap => 1,
435 for (split /,/, $c->{fingerprints}) {
436 die "Invalid fingerprint '$_'\n" unless $valid_fps{$_};
439 $c->{fingerprints} = \%fps
441 $c->{fingerprints} = {oclc => 1, isbn => 1, edition => 1, issn => 1,
442 lccn => 1, accomp => 1, authpub => 1};
445 # check scores list for validity
448 my %valid_scores = ( oclc => 1, dlc => 1, num_650 => 1,
449 num_tags => 1, enc_lvl => 1,
451 for (split /,/, $c->{scores}) {
452 die "Invalid score mode '$_'\n" unless $valid_scores{$_};
455 $c->{dyn_scores} = [split /,/, $c->{scores}];
456 $c->{scores} = \%scores;
458 $c->{scores} = {oclc => 1, dlc => 1, num_650 => 1,
459 num_tags => 1, enc_lvl => 1};
460 $c->{dyn_scores} = [ qw/oclc dlc num_650 num_tags enc_lvl/ ];
464 $c->{tag} = 903 unless defined $c->{tag};
465 $c->{subfield} = 'a' unless defined $c->{subfield};
466 $c->{marctype} = 'XML' unless defined $c->{marctype};
467 $c->{'arbitrarily-decrease-score-by'} = 0
468 unless defined $c->{'arbitrarily-decrease-score-by'};
470 $c->{output} = join('.',$c->{prefix},'fp');
471 $c->{exception} = join('.',$c->{prefix},'fp','ex');
474 my @keys = keys %{$c};
475 show_help() unless (@ARGV and @keys);
476 for my $key ('tag', 'subfield', 'output', 'exception')
477 { push @missing, $key unless $c->{$key} }
479 print "Required option: ", join(', ', @missing), " missing!\n";
485 =head2 progress_ticker
489 sub progress_ticker {
490 return if $conf->{quiet};
491 printf("\r> %d recs seen; %d processed", $count, $scount);
492 printf(" (%d/s)", ($count / (time - $start + 1)))
493 if ($count % 500 == 0);
498 Display usage message when things go wrong
504 Usage is: $0 [REQUIRED ARGS] [OPTIONS] <filelist>
506 --output=<FILE> -o Output filename
507 --exceptions=<FILE> -x Exception report filename
509 --prefix=<PREFIX>> -p Shared prefix for output/exception files. Will
510 produce PREFIX.fp and PREFIX.fp.ex
512 --tag=N -t Which tag to use (default 903)
513 --subfield=X -s Which subfield to use (default 'a')
514 --quiet -q Don't write status messages to STDOUT
516 --fingerprints=LIST Fingerprints to generate, comma separated
517 Default: oclc,isbn,edition,issn,lccn,accomp,authpub
520 --scores=LIST Scores to calculate, comma separated
521 Default: oclc,dlc,num_650,num_tags,enc_level
522 --newwins New record IDs score higher (default is old wins)
523 --arbitrarily-decrease-score-above
524 --arbitrarily-decrease-score-below
525 --arbitrarily-decrease-score-by
526 Modify fingerprint scoring of records whose EG id is above or below a
527 given value, inclusive (so 5 is <= 5 or >= 5). -by gives the amount by
528 which to adjust the score.
530 --marctype=TYPE Defaults to 'XML'