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