marc-cleanup

   1 #!/usr/bin/perl
   2
   3 use strict;
   4 use warnings;
   5
   6 use Getopt::Long;
   7 use Term::ReadLine;
   8
   9 $| = 1;
  10
  11 my $term = new Term::ReadLine 'yaz-cleanup';
  12 my $OUT = $term->OUT || \*STDOUT;
  13
  14 # initialization and setup
  15 my $conf = {};
  16 initialize($conf);
  17 populate_trash() if ($conf->{trash});
  18
  19 my @record  = (); # current record storage
  20 my %recmeta = (); # metadata about current record
  21 my $recptr  = 0;  # record index pointer
  22
  23 my $input = shift || 'incoming.marc.xml';
  24
  25 open MARC, '<:utf8', $input;
  26 open my $NUMARC, '>:utf8', $conf->{output};
  27 print $NUMARC '<?xml version="1.0" encoding="UTF-8"?>',"\n";
  28 print $NUMARC '<collection xmlns="http://www.loc.gov/MARC21/slim">',"\n";
  29
  30 open my $EXMARC, '>:utf8', $conf->{exception};
  31
  32 # this is the dispatch table which drives command selection in
  33 # edit(), below
  34 my %commands = ( c => \&print_context,
  35                  C => \&print_linecontext,
  36                  o => \&show_original,
  37                  f => \&flip_lines,
  38                  k => \&kill_line,
  39                  m => \&merge_lines,
  40                  n => \&next_line,
  41                  p => \&prev_line,
  42                  s => \&substitute,
  43                  t => \&commit_edit,
  44                  x => \&dump_record,
  45                  q => \&quit,
  46                  '?' => \&help,
  47                  h   => \&help,
  48                  help => \&help,
  49                );
  50
  51 my @spinner = qw(- / | \\);
  52 my $sidx = 0;
  53
  54 while ( buildrecord() ) {
  55     unless ($conf->{ricount} % 100) {
  56         print "\rWorking... ", $spinner[$sidx];
  57         $sidx = ($sidx == $#spinner) ? 0 : $sidx + 1;
  58     }
  59
  60     do_automated_cleanups();
  61
  62     $recptr = 0;
  63     until ($recptr == $#record) {
  64         # naked ampersands
  65         if ($record[$recptr] =~ /&/ && $record[$recptr] !~ /&\w+?;/)
  66           { edit("Naked ampersand"); $recptr= 0; next }
  67
  68         # tags must be numeric
  69         if ($record[$recptr] =~ /<datafield tag="(.+?)"/) {
  70             my $match = $1;
  71             if ($match =~ /\D/) {
  72                 edit("Non-numerics in tag");
  73                 $recptr = 0;
  74                 next;
  75             }
  76         }
  77
  78         # subfields can't be non-alphanumeric
  79         if ($record[$recptr] =~ /<subfield code="(.*?)"/) {
  80             my $match = $1;
  81             if ($match =~ /\P{IsAlnum}/ or $match eq '') {
  82                 edit("Junk in subfield code/Null subfield code");
  83                 $recptr = 0;
  84                 next;
  85             }
  86         }
  87         $recptr++;
  88     }
  89     write_record($NUMARC);
  90 }
  91 print $NUMARC "</collection>\n";
  92 print $OUT "\nDone.               \n";
  93
  94
  95 #-----------------------------------------------------------------------------------
  96 # cleanup routines
  97 #-----------------------------------------------------------------------------------
  98
  99 sub do_automated_cleanups {
 100     $recptr = 0;
 101     until ($recptr == $#record) {
 102         # catch empty datafield elements
 103         if ($record[$recptr] =~ m/<datafield tag="..." ind1="." ind2=".">/) {
 104             if ($record[$recptr + 1] =~ m|</datafield>|) {
 105                 my @a = @record[0 .. $recptr - 1];
 106                 my @b = @record[$recptr + 2 .. $#record];
 107                 @record = (@a, @b);
 108                 message("Empty datafield scrubbed");
 109                 $recptr = 0;
 110                 next;
 111             }
 112         }
 113         # and quasi-empty subfields
 114         if ($record[$recptr] =~ m|<subfield code="(.*?)">(.*?)</sub|) {
 115             my $code = $1; my $content = $2;
 116             if ($code =~ /\W/ and ($content =~ /\s+/ or $content eq '')) {
 117                 my @a = @record[0 .. $recptr - 1];
 118                 my @b = @record[$recptr + 1 .. $#record];
 119                 @record = (@a, @b);
 120                 message("Empty subfield scrubbed");
 121                 $recptr = 0;
 122                 next;
 123             }
 124         }
 125         $recptr++;
 126     }
 127
 128     # single-line fixes
 129     for $recptr (0 .. $#record) {
 130         # pad short leaders
 131         if ($record[$recptr] =~ m|<leader>(.+?)</leader>|) {
 132             my $leader = $1;
 133             if (length $leader < 24) {
 134                 $leader .= ' ' x (20 - length($leader));
 135                 $leader .= "4500";
 136                 $record[$recptr] = "<leader>$leader</leader>\n";
 137                 message("Short leader padded");
 138             }
 139         }
 140         if ($record[$recptr] =~ m|<controlfield tag="008">(.+?)</control|) {
 141             #pad short 008
 142             my $content = $1;
 143             if (length $content < 40) {
 144                 $content .= ' ' x (40 - length($content));
 145                 $record[$recptr] = "<controlfield tag=\"008\">$content</controlfield>\n";
 146                 message("Short 008 padded");
 147             }
 148         }
 149
 150         # clean misplaced dollarsigns
 151         if ($record[$recptr] =~ m|<subfield code="\$">c?\d+\.\d{2}|) {
 152             $record[$recptr] =~ s|"\$">c?(\d+\.\d{2})|"c">\$$1|;
 153             message("Dollar sign corrected");
 154         }
 155
 156         # clean up tags with spaces in them
 157         $record[$recptr] =~ s/tag="  /tag="00/g;
 158         $record[$recptr] =~ s/tag=" /tag="0/g;
 159         $record[$recptr] =~ s/tag="-/tag="0/g;
 160         $record[$recptr] =~ s/tag="(\d\d) /tag="0$1/g;
 161
 162         # stow tag data if we're looking at it
 163         if ($record[$recptr] =~ m/<datafield tag="(.{3})" ind1="(.)" ind2="(.)">/) {
 164             $recmeta{tag}  = $1;
 165             $recmeta{ind1} = $2;
 166             $recmeta{ind2} = $3;
 167         }
 168
 169         # automatable subfield maladies
 170         $record[$recptr] =~ s/code=" ">c/code="c">/;
 171         $record[$recptr] =~ s/code=" ">\$/code="c"$>/;
 172     }
 173 }
 174
 175 #-----------------------------------------------------------------------------------
 176 # driver routines
 177 #-----------------------------------------------------------------------------------
 178
 179
 180 =head2 edit
 181
 182 Handles the Term::ReadLine loop
 183
 184 =cut
 185
 186 sub edit {
 187     my ($msg) = @_;
 188
 189     return if $conf->{trash}{ $recmeta{tag} };
 190     message($msg, 1);
 191     print_context();
 192
 193     # stow original problem line
 194     $conf->{origline} = $record[$recptr];
 195
 196     while (1) {
 197         my $line = $term->readline('marc-cleanup>');
 198         my @chunks = split /\s+/, $line;
 199
 200         if (length $chunks[0] == 1)
 201           { next unless (defined $commands{$chunks[0]}) }
 202
 203         if (defined $commands{$chunks[0]}) {
 204             my $term = $commands{$chunks[0]}->(@chunks[1..$#chunks]);
 205             last if $term;
 206         } else {
 207             $record[$recptr] = "$line\n";
 208             print_linecontext();
 209         }
 210     }
 211 }
 212
 213 =head2 buildrecord
 214
 215 Constructs record arrays from the incoming MARC file and returns them
 216 to the driver loop.
 217
 218 =cut
 219
 220 sub buildrecord {
 221     my $l = '';
 222     $l = <MARC> while (defined $l and $l !~ /<record>/);
 223     return $l unless defined $l;
 224     @record = ($l);
 225     %recmeta = ();
 226     $conf->{ricount}++;
 227
 228     until ($l =~ m|</record>|)
 229       { push @record, $l; $l = <MARC>; }
 230     push @record, $l;
 231     return 1;
 232 }
 233
 234 sub write_record {
 235     my ($FH) = @_;
 236     my $trash = $conf->{trash};
 237
 238     $conf->{rocount}++ if ($FH eq $NUMARC);
 239     print $FH '<!-- ', $recmeta{explanation}, " -->\n"
 240       if(defined $recmeta{explanation});
 241
 242     # excise unwanted tags
 243     if (keys %{$trash} or $conf->{autoscrub}) {
 244         my @trimmed = ();
 245         my $istrash = 0;
 246         for my $line (@record) {
 247             if ($istrash) {
 248                 $istrash = 0 if $line =~ m|</datafield|;
 249                 next;
 250             }
 251             if ($line =~ m/<datafield tag="(.{3})"/) {
 252                 my $tag = $1;
 253                 if ($trash->{$tag} or ($conf->{autoscrub} and $tag =~ /\D/)) {
 254                     $istrash = 1;
 255                     next
 256                 }
 257             }
 258             push @trimmed, $line;
 259         }
 260         @record = @trimmed;
 261     }
 262
 263     # scrub newlines
 264     unless ($conf->{nocollapse}) {
 265         s/\n// for (@record);
 266     }
 267
 268     # add 903(?) with new record id
 269     my $renumber = '';
 270     if ($conf->{'renumber-from'}) {
 271         $renumber = join('', '<datafield tag="', $conf->{'renumber-tag'},
 272                          '" ind1=" " ind2=" ">',
 273                          '<subfield code="', $conf->{'renumber-subfield'}, '">',
 274                          $conf->{'renumber-from'}, '</subfield></datafield>');
 275         $renumber .= "\n" if $conf->{nocollapse};
 276         push @record, $renumber;
 277         $conf->{'renumber-from'}++;
 278     }
 279
 280     print $FH @record;
 281     print $FH "</record>\n";
 282 }
 283
 284 sub print_context {
 285     print "    Tag:",$recmeta{tag}, " Ind1:'",
 286       $recmeta{ind1},"' Ind2:'", $recmeta{ind2}, "'\n";
 287     print_linecontext();
 288     return 0;
 289 }
 290
 291 sub print_linecontext {
 292     my $low = ($recptr - 3 < 0) ? 0 : $recptr - 3;
 293     print $OUT '    |', $record[$_] for ($low .. $recptr - 1);
 294     print $OUT '==> |', $record[$recptr];
 295     print $OUT '    |', $record[$recptr + 1], "\n";
 296     return 0;
 297 }
 298
 299 sub message {
 300     my ($msg, $new) = @_;
 301     print $OUT "\r", ' ' x 72, "\n" if $new;
 302     print $OUT "\r$msg at ",$conf->{ricount},"/",$conf->{rocount} + 1,"\n";
 303
 304 }
 305
 306 #-----------------------------------------------------------------------------------
 307 # command routines
 308 #-----------------------------------------------------------------------------------
 309
 310 sub substitute {
 311     my ($line_in, @chunks) = @_;
 312     my $ofrom = shift @chunks;
 313     if ($ofrom =~ /^'/ or !@chunks) {
 314         until ($ofrom =~ /'$/)
 315           { $ofrom .= join(' ','',shift @chunks) }
 316         $ofrom =~ s/^'//; $ofrom =~ s/'$//;
 317     }
 318     my $to = shift @chunks;
 319     if ($to =~ /^'/) {
 320         until ($to =~ /'$/ or !@chunks)
 321           { $to .= join(' ','',shift @chunks) }
 322         $to =~ s/^'//; $to =~ s/'$//;
 323     }
 324
 325     my $from = '';
 326     for my $char (split(//,$ofrom)) {
 327         $char = "\\" . $char if ($char =~ /\W/);
 328         $from = join('', $from, $char);
 329     }
 330     $record[$recptr] =~ s/$from/$to/;
 331     print_linecontext();
 332     return 0;
 333 }
 334
 335 sub merge_lines {
 336     # remove <subfield stuff; extract (probably wrong) subfield code
 337     $record[$recptr] =~ s/^\s*<subfield code="(.*?)">//;
 338     # and move to front of line
 339     $record[$recptr] = join(' ', $1 , $record[$recptr]);
 340     # tear off trailing subfield tag from preceeding line
 341     $record[$recptr - 1] =~ s|</subfield>\n||;
 342     # join current line onto preceeding line
 343     $record[$recptr - 1] = join('', $record[$recptr - 1], $record[$recptr]);
 344     # erase current line
 345     my @a = @record[0 .. $recptr - 1];
 346     my @b = @record[$recptr + 1 .. $#record];
 347     @record = (@a, @b);
 348     # move record pointer to previous line
 349     prev_line();
 350     print_linecontext();
 351     return 0;
 352 }
 353
 354 sub kill_line {
 355     my @a = @record[0 .. $recptr - 1];
 356     my @b = @record[$recptr + 1 .. $#record];
 357     @record = (@a, @b);
 358     print_linecontext();
 359     return 0;
 360 }
 361
 362 sub dump_record {
 363     my ($line_in, @explanation) = @_;
 364     $recmeta{explanation} = join(' ', 'Tag', $recmeta{tag}, @explanation);
 365     write_record($EXMARC);
 366     return 1;
 367 }
 368
 369 sub next_line {
 370     $recptr++;
 371     print_linecontext();
 372     return 0;
 373 }
 374
 375 sub prev_line {
 376     $recptr--;
 377     print_linecontext();
 378     return 0;
 379 }
 380
 381 sub show_original {
 382     my ($line_in) = @_;
 383     print $OUT "\n", $conf->{origline}, "\n";
 384     return 0;
 385 }
 386
 387 sub commit_edit { return 1 }
 388
 389 sub help {
 390 print $OUT <<HELP;
 391
 392 Type a replacement for the indicated line, or enter a command.
 393
 394 Commands: c  Show record context again ('C' for brief context)
 395           k  Kill indicated line (remove from record)
 396           m  Merge indicated line with previous line
 397           o  Show original line
 398           s  Substitute ARG1 for ARG2 in indicated line
 399           t  Commit changes and resume stream edit
 400           x  Write this record to the exception file instead of output
 401           q  Quit
 402
 403 HELP
 404 return 0;
 405 }
 406
 407 sub quit { exit }
 408
 409 #-----------------------------------------------------------------------------------
 410 # populate_trash
 411 #-----------------------------------------------------------------------------------
 412 # defined a domain-specific language for specifying MARC tags to be dropped from
 413 # records during processing. it is line oriented, and is specified as follows:
 414 #
 415 # each line may specify any number of tags to be included, either singly (\d{1,3})
 416 # or as a range (\d{1,3}\.\.\d{1,3}
 417 #
 418 # if a single number is given, it must be between '000' and '999', inclusive.
 419 #
 420 # ranges obey the previous rule, and also the first number of the range must be less
 421 # than the second number
 422 #
 423 # finally, any single range in a line may be followed by the keyword 'except'. every
 424 # number or range after 'except' is excluded from the range specified. all these
 425 # numbers must actually be within the range.
 426 #
 427 # specifying a tag twice is an error, to help prevent typos
 428
 429 sub populate_trash {
 430     print $OUT ">>> TRASHTAGS FILE FOUND. LOADING TAGS TO BE STRIPPED FROM OUTPUT\n";
 431     open TRASH, '<', $conf->{trash}
 432       or die "Can't open trash tags file!\n";
 433     while (<TRASH>) {
 434         my $lastwasrange = 0;
 435         my %lastrange = ( high => 0, low => 0);
 436         my $except = 0;
 437
 438         my @chunks = split /\s+/;
 439         while (my $chunk = shift @chunks) {
 440
 441             # single values
 442             if ($chunk =~ /^\d{1,3}$/) {
 443                 trash_add($chunk, $except);
 444                 $lastwasrange = 0;
 445                 next;
 446             }
 447
 448             # ranges
 449             if ($chunk =~ /^\d{1,3}\.\.\d{1,3}$/) {
 450                 my ($low, $high) = trash_add_range($chunk, $except, \%lastrange);
 451                 $lastwasrange = 1;
 452                 %lastrange = (low => $low, high => $high)
 453                   unless $except;
 454                 next;
 455             }
 456
 457             # 'except'
 458             if ($chunk eq 'except') {
 459                 die "Keyword 'except' can only follow a range (line $.)\n"
 460                   unless $lastwasrange;
 461                 die "Keyword 'except' may only occur once per line (line $.)\n"
 462                   if $except;
 463                 $except = 1;
 464                 next;
 465             }
 466
 467             die "Unknown chunk $chunk in .trashtags file (line $.)\n";
 468         }
 469     }
 470
 471     # remove original id sequence tag from trash hash if we know it
 472     trash_add($conf->{'original-tag'}, 1)
 473       if ($conf->{'original-tag'} and $conf->{trash}{ $conf->{'original-tag'} });
 474 }
 475
 476 sub trash_add_range {
 477     my ($chunk, $except, $range) = @_;
 478     my ($low,$high) = split /\.\./, $chunk;
 479     die "Ranges must be 'low..high' ($low is greater than $high on line $.)\n"
 480       if ($low > $high);
 481     if ($except) {
 482         die "Exception ranges must be within last addition range (line $.)\n"
 483           if ($low < $range->{low} or $high > $range->{high});
 484     }
 485     for my $tag ($low..$high) {
 486         trash_add($tag, $except)
 487     }
 488     return $low, $high;
 489 }
 490
 491 sub trash_add {
 492     my ($tag, $except) = @_;
 493     my $trash = $conf->{trash};
 494
 495     die "Trash values must be valid tags (000-999)\n"
 496       unless ($tag >= 0 and $tag <= 999);
 497
 498     if ($except) {
 499         delete $trash->{$tag};
 500     } else {
 501         die "Trash tag '$tag' specified twice (line $.)\n"
 502           if $trash->{$tag};
 503         $trash->{$tag} = 1;
 504     }
 505 }
 506
 507 #-----------------------------------------------------------------------
 508
 509 =head2 initialize
 510
 511 Performs boring script initialization. Handles argument parsing,
 512 mostly.
 513
 514 =cut
 515
 516 sub initialize {
 517     my ($c) = @_;
 518     my @missing = ();
 519
 520     # set mode on existing filehandles
 521     binmode(STDIN, ':utf8');
 522
 523     my $rc = GetOptions( $c,
 524                          'autoscrub|a',
 525                          'exception|x=s',
 526                          'output|o=s',
 527                          'nocollapse|n',
 528                          'renumber-from|rf=i',
 529                          'original-tag|ot=i',
 530                          'renumber-tag|rt=i',
 531                          'renumber-subfield|rt=i',
 532                          'trash|t=s',
 533                          'help|h',
 534                        );
 535     show_help() unless $rc;
 536     show_help() if ($c->{help});
 537
 538     # defaults
 539     $c->{output} = 'incoming.cleaned.marc.xml' unless defined $c->{output};
 540     $c->{exception} = 'incoming.exception.marc.xml' unless defined $c->{exception};
 541     $c->{'renumber-tag'} = 903 unless defined $c->{'renumber-tag'};
 542     $c->{'renumber-subfield'} = 'a' unless defined $c->{'renumber-subfield'};
 543
 544     my @keys = keys %{$c};
 545     show_help() unless (@ARGV and @keys);
 546     #for my $key ('runtype', 'tag', 'subfield', 'output', 'exception')
 547     #  { push @missing, $key unless $c->{$key} }
 548     #if (@missing) {
 549     #    print "Required option: ", join(', ', @missing), " missing!\n";
 550     #    show_help();
 551     #}
 552 }
 553
 554 sub show_help {
 555     print <<HELP;
 556 Usage is: $0 [OPTIONS] <filelist>
 557 Options
 558   --output     -o  Cleaned MARCXML output filename (default: incoming.cleaned.marc.xml)
 559   --exception  -x  Exception (dumped records) MARCXML filename (incoming.exception.marc.xml)
 560 HELP
 561 exit;
 562 }