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'}, '">',
 235           '<subfield code="', $conf->{'renumber-subfield'}, '">',
 236           $conf->{'renumber-from'}, '</subfield></datafield>';
 237         print $FH "\n" unless $conf->{oneperline};
 238         $conf->{'renumber-from'}++;
 239     }
 240
 241     print $FH @record;
 242     print $FH '</record>\n';
 243 }
 244
 245 sub update_linecontext {
 246     my $line2 = <MARC2>;
 247     push @context, $line2;
 248     shift @context if (@context > 5);
 249 }
 250
 251 sub message {
 252     my ($msg) = @_;
 253     print $OUT "\r$msg at record $reccount/",$oreccount + 1,"\n";
 254
 255 }
 256
 257 #-----------------------------------------------------------------------------------
 258 # command routines
 259 #-----------------------------------------------------------------------------------
 260
 261 sub substitute {
 262     my ($line_in, @chunks) = @_;
 263     my $ofrom = shift @chunks;
 264     if ($ofrom =~ /^'/ or !@chunks) {
 265         until ($ofrom =~ /'$/)
 266           { $ofrom .= join(' ','',shift @chunks) }
 267         $ofrom =~ s/^'//; $ofrom =~ s/'$//;
 268     }
 269     my $to = shift @chunks;
 270     if ($to =~ /^'/) {
 271         until ($to =~ /'$/ or !@chunks)
 272           { $to .= join(' ','',shift @chunks) }
 273         $to =~ s/^'//; $to =~ s/'$//;
 274     }
 275
 276     my $from = '';
 277     for my $char (split(//,$ofrom)) {
 278         $char = "\\" . $char if ($char =~ /\W/);
 279         $from = join('', $from, $char);
 280     }
 281     $record[-1] =~ s/$from/$to/;
 282     $context[3] = $record[-1];
 283     print_linecontext();
 284     return 0;
 285 }
 286
 287 sub merge_lines {
 288     my $last = pop @record;
 289     $last =~ s/^\s+//;
 290     $record[-1] =~ s/\n//;
 291     $record[-1] = join('', $record[-1], $last);
 292     my @temp = ("\n");
 293     push @temp, @context[0..1];
 294     $temp[3] = $record[-1];
 295     $temp[4] = $context[4];
 296     @context = @temp;
 297     print_linecontext();
 298     return 0;
 299 }
 300
 301 sub kill_line {
 302     pop @record;
 303     $context[3] = " [LINE KILLED]\n";
 304     print_linecontext();
 305     return 0;
 306 }
 307
 308 sub dump_record {
 309     my ($line_in, @explanation) = @_;
 310     $recmeta{explanation} = join(' ', 'Tag', $recmeta{tag}, @explanation);
 311     my $line = <MARC>; $count++;
 312     update_linecontext();
 313     until ($line =~ m|</record>|) {
 314         push @record, $line;
 315         $line = <MARC>; $count++;
 316         update_linecontext();
 317     }
 318     push @record, $line;
 319     write_record($EXMARC);
 320     return 1;
 321 }
 322
 323 sub commit_edit { return 1 }
 324
 325 sub print_context {
 326     print "\n Tag:",$recmeta{tag}, " Ind1:'",
 327       $recmeta{ind1},"' Ind2:'", $recmeta{ind2}, "'";
 328     print_linecontext();
 329     return 0;
 330 }
 331
 332 sub print_linecontext {
 333     print $OUT "\n", join('    |','',@context[0..2]);
 334     print $OUT '==> |', $context[3];
 335     print $OUT '    |', $context[4],"\n";
 336     return 0;
 337 }
 338
 339 sub show_original {
 340     my ($line_in) = @_;
 341     print $OUT "\n$line_in\n";
 342     return 0;
 343 }
 344
 345 sub help {
 346 print $OUT <<HELP;
 347
 348 Type a replacement for the indicated line, or enter a command.
 349
 350 Commands: c  Show record context ('C' for brief context)
 351           k  Kill indicated line (remove from record)
 352           m  Merge indicated line with previous line
 353           o  Show original line
 354           s  Substitute ARG1 for ARG2 in indicated line
 355           t  Commit changes and resume stream edit
 356           x  Write this record to the exception file instead of output
 357           q  Quit
 358
 359 HELP
 360 return 0;
 361 }
 362
 363 sub quit { exit }
 364
 365 #-----------------------------------------------------------------------------------
 366 # populate_trash
 367 #-----------------------------------------------------------------------------------
 368 # defined a domain-specific language for specifying MARC tags to be dropped from
 369 # records during processing. it is line oriented, and is specified as follows:
 370 #
 371 # each line may specify any number of tags to be included, either singly (\d{1,3})
 372 # or as a range (\d{1,3}\.\.\d{1,3}
 373 #
 374 # if a single number is given, it must be between '000' and '999', inclusive.
 375 #
 376 # ranges obey the previous rule, and also the first number of the range must be less
 377 # than the second number
 378 #
 379 # finally, any single range in a line may be followed by the keyword 'except'. every
 380 # number or range after 'except' is excluded from the range specified. all these
 381 # numbers must actually be within the range.
 382 #
 383 # specifying a tag twice is an error, to help prevent typos
 384
 385 sub populate_trash {
 386     print $OUT ">>> TRASHTAGS FILE FOUND. LOADING TAGS TO BE STRIPPED FROM OUTPUT...\n";
 387     open TRASH, '<', '.trashtags';
 388     while (<TRASH>) {
 389         my $lastwasrange = 0;
 390         my %lastrange = ( high => 0, low => 0);
 391         my $except = 0;
 392
 393         my @chunks = split /\s+/;
 394         while (my $chunk = shift @chunks) {
 395
 396             # single values
 397             if ($chunk =~ /^\d{1,3}$/) {
 398                 trash_add($chunk, $except);
 399                 $lastwasrange = 0;
 400                 next;
 401             }
 402
 403             # ranges
 404             if ($chunk =~ /^\d{1,3}\.\.\d{1,3}$/) {
 405                 my ($low, $high) = trash_add_range($chunk, $except, \%lastrange);
 406                 $lastwasrange = 1;
 407                 %lastrange = (low => $low, high => $high)
 408                   unless $except;
 409                 next;
 410             }
 411
 412             # 'except'
 413             if ($chunk eq 'except') {
 414                 die "Keyword 'except' can only follow a range (line $.)\n"
 415                   unless $lastwasrange;
 416                 die "Keyword 'except' may only occur once per line (line $.)\n"
 417                   if $except;
 418                 $except = 1;
 419                 next;
 420             }
 421
 422             die "Unknown chunk $chunk in .trashtags file (line $.)\n";
 423         }
 424     }
 425
 426     # remove original id sequence tag from trash hash if we know it
 427     trash_add($conf->{'original-tag'}, 1)
 428       if ($conf->{'original-tag'} and $trash{$conf->{'original-tag'}});
 429 }
 430
 431 sub trash_add_range {
 432     my ($chunk, $except, $range) = @_;
 433     my ($low,$high) = split /\.\./, $chunk;
 434     die "Ranges must be 'low..high' ($low is greater than $high on line $.)\n"
 435       if ($low > $high);
 436     if ($except) {
 437         die "Exception ranges must be within last addition range (line $.)\n"
 438           if ($low < $range->{low} or $high > $range->{high});
 439     }
 440     for my $tag ($low..$high) {
 441         trash_add($tag, $except)
 442     }
 443     return $low, $high;
 444 }
 445
 446 sub trash_add {
 447     my ($tag, $except) = @_;
 448     die "Trash values must be valid tags (000-999)\n"
 449       unless ($tag >= 0 and $tag <= 999);
 450     if ($except) {
 451         delete $trash{$tag};
 452     } else {
 453         die "Trash tag '$tag' specified twice (line $.)\n"
 454           if $trash{$tag};
 455         $trash{$tag} = 1;
 456     }
 457 }
 458
 459 #-----------------------------------------------------------------------
 460
 461 =head2 initialize
 462
 463 Performs boring script initialization. Handles argument parsing,
 464 mostly.
 465
 466 =cut
 467
 468 sub initialize {
 469     my ($c) = @_;
 470     my @missing = ();
 471
 472     # set mode on existing filehandles
 473     binmode(STDIN, ':utf8');
 474
 475     my $rc = GetOptions( $c,
 476                          'autoscrub|a',
 477                          'exception|x=s',
 478                          'output|o=s',
 479                          'nocollapse|n',
 480                          'renumber-from|rf=i',
 481                          'original-tag|ot=i',
 482                          'renumber-tag|rt=i',
 483                          'renumber-subfield|rt=i',
 484                          'help|h',
 485                        );
 486     show_help() unless $rc;
 487     show_help() if ($c->{help});
 488
 489     # defaults
 490     $c->{output} = 'incoming.cleaned.marc.xml' unless defined $c->{output};
 491     $c->{exception} = 'incoming.exception.marc.xml' unless defined $c->{exception};
 492     $c->{'renumber-tag'} = 903 unless defined $c->{'renumber-tag'};
 493     $c->{'renumber-subfield'} = 'a' unless defined $c->{'renumber-subfield'};
 494
 495     my @keys = keys %{$c};
 496     show_help() unless (@ARGV and @keys);
 497     #for my $key ('runtype', 'tag', 'subfield', 'output', 'exception')
 498     #  { push @missing, $key unless $c->{$key} }
 499     #if (@missing) {
 500     #    print "Required option: ", join(', ', @missing), " missing!\n";
 501     #    show_help();
 502     #}
 503 }
 504
 505 sub show_help {
 506     print <<HELP;
 507 Usage is: $0 [OPTIONS] <filelist>
 508 Options
 509   --output     -o  Cleaned MARCXML output filename (default: incoming.cleaned.marc.xml)
 510   --exception  -x  Exception (dumped records) MARCXML filename (incoming.exception.marc.xml)
 511 HELP
 512 exit;
 513 }