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                  k => \&kill_line,
  37                  o => \&show_original,
  38                  m => \&merge_lines,
  39                  s => \&substitute,
  40                  t => \&commit_edit,
  41                  x => \&dump_record,
  42                  q => \&quit,
  43                  '?' => \&help,
  44                  h   => \&help,
  45                  help => \&help,
  46                );
  47
  48 my @spinner = qw(- / | \\);
  49 my $sidx = 0;
  50
  51 while ( buildrecord() ) {
  52     print "\rWorking... ", $spinner[$sidx];
  53     $sidx = ($sidx == $#spinner) ? 0 : $sidx + 1;
  54
  55     do_automated_cleanups();
  56
  57     $recptr = 0;
  58     until ($recptr == $#record) {
  59         # naked ampersands
  60         if ($record[$recptr] =~ /&/ && $record[$recptr] !~ /&\w+?;/)
  61           { edit("Naked ampersand"); $recptr= 0; next }
  62
  63         # tags must be numeric
  64         if ($record[$recptr] =~ /<datafield tag="(.+?)"/) {
  65             my $match = $1;
  66             if ($match =~ /\D/) {
  67                 edit("Non-numerics in tag");
  68                 $recptr = 0;
  69                 next;
  70             }
  71         }
  72
  73         # subfields can't be non-alphanumeric
  74         if ($record[$recptr] =~ /<subfield code="(.*?)"/) {
  75             my $match = $1;
  76             if ($match =~ /\P{IsAlnum}/ or $match eq '') {
  77                 edit("Junk in subfield code/Null subfield code");
  78                 $recptr = 0;
  79                 next;
  80             }
  81         }
  82         $recptr++;
  83     }
  84
  85     write_record($NUMARC);
  86 }
  87 print $NUMARC "</collection>\n";
  88 print $OUT "\nDone.               \n";
  89
  90
  91 #-----------------------------------------------------------------------------------
  92 # cleanup routines
  93 #-----------------------------------------------------------------------------------
  94
  95 sub do_automated_cleanups {
  96     $recptr = 0;
  97     until ($recptr == $#record) {
  98         # catch empty datafield elements
  99         if ($record[$recptr] =~ m|</datafield>|) {
 100             if ($record[$recptr + 1] =~ m/<datafield tag="..." ind1="." ind2=".">/) {
 101                 my @a = @record[0, $recptr - 1];
 102                 my @b = @record[$recptr + 1, $#record];
 103                 @record = (@a, @b);
 104                 message("Empty datafield scrubbed");
 105                 $recptr = 0;
 106                 next;
 107             }
 108         }
 109         # and quasi-empty subfields
 110         if ($record[$recptr] =~ m|<subfield code="\s*">\s*</sub|) {
 111             delete $record[$recptr];
 112             message("Empty subfield scrubbed");
 113             $recptr = 0;
 114             next;
 115         }
 116         $recptr++;
 117     }
 118
 119     # single-line fixes
 120     for $recptr (0 .. $#record) {
 121         # pad short leaders
 122         if ($record[$recptr] =~ m|<leader>(.+?)</leader>|) {
 123             my $leader = $1;
 124             if (length $leader < 24) {
 125                 $leader .= ' ' x (20 - length($leader));
 126                 $leader .= "4500";
 127                 $record[$recptr] = "<leader>$leader</leader>\n";
 128                 message("Short leader padded");
 129             }
 130         }
 131
 132         # clean misplaced dollarsigns
 133         if ($record[$recptr] =~ m|<subfield code="\$">c?\d+\.\d{2}|) {
 134             $record[$recptr] =~ s|"\$">c?(\d+\.\d{2})|"c">\$$1|;
 135             message("Dollar sign corrected");
 136         }
 137
 138         # clean up tags with spaces in them
 139         $record[$recptr] =~ s/tag="  /tag="00/g;
 140         $record[$recptr] =~ s/tag=" /tag="0/g;
 141         $record[$recptr] =~ s/tag="-/tag="0/g;
 142         $record[$recptr] =~ s/tag="(\d\d) /tag="0$1/g;
 143
 144         # stow tag data if we're looking at it
 145         if ($record[$recptr] =~ m/<datafield tag="(.{3})" ind1="(.)" ind2="(.)">/) {
 146             $recmeta{tag}  = $1;
 147             $recmeta{ind1} = $2;
 148             $recmeta{ind2} = $3;
 149         }
 150
 151         # automatable subfield maladies
 152         $record[$recptr] =~ s/code=" ">c/code="c">/;
 153         $record[$recptr] =~ s/code=" ">\$/code="c"$>/;
 154     }
 155 }
 156
 157 #-----------------------------------------------------------------------------------
 158 # driver routines
 159 #-----------------------------------------------------------------------------------
 160
 161
 162 =head2 edit
 163
 164 Handles the Term::ReadLine loop
 165
 166 =cut
 167
 168 sub edit {
 169     my ($msg) = @_;
 170     my $trash = $conf->{trash};
 171
 172     return if $trash->{ $recmeta{tag} };
 173     message($msg);
 174     print_context();
 175
 176     while (1) {
 177         my $line = $term->readline('marc-cleanup>');
 178         my @chunks = split /\s+/, $line;
 179
 180         if (length $chunks[0] == 1)
 181           { next unless (defined $commands{$chunks[0]}) }
 182
 183         if (defined $commands{$chunks[0]}) {
 184             my $term = $commands{$chunks[0]}->(@chunks[1..$#chunks]);
 185             last if $term;
 186         } else {
 187             $record[$recptr] = "$line\n";
 188             print_linecontext();
 189         }
 190     }
 191 }
 192
 193 =head2 buildrecord
 194
 195 Constructs record arrays from the incoming MARC file and returns them
 196 to the driver loop.
 197
 198 =cut
 199
 200 sub buildrecord {
 201     my $l = <MARC>;
 202     return $l unless defined $l;
 203
 204     $l = <MARC> until ($l =~ /<record>/);
 205     @record = ($l);
 206     %recmeta = ();
 207     $conf->{ricount}++;
 208
 209     until ($l =~ m|</record>|)
 210       { push @record, $l; $l = <MARC>; }
 211     push @record, $l;
 212     return 1;
 213 }
 214
 215 sub write_record {
 216     my ($FH) = @_;
 217     my $trash = $conf->{trash};
 218
 219     $conf->{rocount}++ if ($FH eq $NUMARC);
 220     print $FH '<!-- ', $recmeta{explanation}, " -->\n"
 221       if(defined $recmeta{explanation});
 222
 223     # excise unwanted tags
 224     if (keys %{$trash} or $conf->{autoscrub}) {
 225         my @trimmed = ();
 226         my $istrash = 0;
 227         for my $line (@record) {
 228             if ($istrash) {
 229                 $istrash = 0 if $line =~ m|</datafield|;
 230                 next;
 231             }
 232             if ($line =~ m/<datafield tag="(.{3})"/) {
 233                 my $tag = $1;
 234                 if ($trash->{$tag} or ($conf->{autoscrub} and $tag =~ /\D/)) {
 235                     $istrash = 1;
 236                     next
 237                 }
 238             }
 239             push @trimmed, $line;
 240         }
 241         @record = @trimmed;
 242     }
 243
 244     # scrub newlines
 245     unless ($conf->{nocollapse}) {
 246         s/\n// for (@record);
 247     }
 248
 249     # add 903(?) with new record id
 250     my $renumber = '';
 251     if ($conf->{'renumber-from'}) {
 252         $renumber = join('', '<datafield tag="', $conf->{'renumber-tag'},
 253                          '" ind1=" " ind2=" ">',
 254                          '<subfield code="', $conf->{'renumber-subfield'}, '">',
 255                          $conf->{'renumber-from'}, '</subfield></datafield>');
 256         $renumber .= "\n" if $conf->{nocollapse};
 257         push @record, $renumber;
 258         $conf->{'renumber-from'}++;
 259     }
 260
 261     print $FH @record;
 262     print $FH "</record>\n";
 263 }
 264
 265 sub message {
 266     my ($msg) = @_;
 267     print $OUT "\r", ' ' x 72, "\n";
 268     print $OUT "$msg at ",$conf->{ricount},"/",$conf->{rocount} + 1,"\n";
 269
 270 }
 271
 272 #-----------------------------------------------------------------------------------
 273 # command routines
 274 #-----------------------------------------------------------------------------------
 275
 276 sub substitute {
 277     my ($line_in, @chunks) = @_;
 278     my $ofrom = shift @chunks;
 279     if ($ofrom =~ /^'/ or !@chunks) {
 280         until ($ofrom =~ /'$/)
 281           { $ofrom .= join(' ','',shift @chunks) }
 282         $ofrom =~ s/^'//; $ofrom =~ s/'$//;
 283     }
 284     my $to = shift @chunks;
 285     if ($to =~ /^'/) {
 286         until ($to =~ /'$/ or !@chunks)
 287           { $to .= join(' ','',shift @chunks) }
 288         $to =~ s/^'//; $to =~ s/'$//;
 289     }
 290
 291     my $from = '';
 292     for my $char (split(//,$ofrom)) {
 293         $char = "\\" . $char if ($char =~ /\W/);
 294         $from = join('', $from, $char);
 295     }
 296     $record[$recptr] =~ s/$from/$to/;
 297     print_linecontext();
 298     return 0;
 299 }
 300
 301 sub merge_lines {
 302     $record[$recptr] =~ s/^\s*<subfield code=".*">//;
 303     $record[$recptr - 1] =~ s|<subfield>\n||;
 304     $record[$recptr - 1] = join('', $record[$recptr - 1], $record[$recptr]);
 305     print_linecontext();
 306     return 0;
 307 }
 308
 309 sub kill_line {
 310     delete $record[$recptr];
 311     print_linecontext();
 312     return 0;
 313 }
 314
 315 sub dump_record {
 316     my ($line_in, @explanation) = @_;
 317     $recmeta{explanation} = join(' ', 'Tag', $recmeta{tag}, @explanation);
 318     write_record($EXMARC);
 319     return 1;
 320 }
 321
 322 sub commit_edit { return 1 }
 323
 324 sub print_context {
 325     print " 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, '<', $conf->{trash}
 387       or die "Can't open trash tags file!\n";
 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     my $trash = $conf->{trash}
 449
 450     die "Trash values must be valid tags (000-999)\n"
 451       unless ($tag >= 0 and $tag <= 999);
 452
 453     if ($except) {
 454         delete $trash->{$tag};
 455     } else {
 456         die "Trash tag '$tag' specified twice (line $.)\n"
 457           if $trash->{$tag};
 458         $trash->{$tag} = 1;
 459     }
 460 }
 461
 462 #-----------------------------------------------------------------------
 463
 464 =head2 initialize
 465
 466 Performs boring script initialization. Handles argument parsing,
 467 mostly.
 468
 469 =cut
 470
 471 sub initialize {
 472     my ($c) = @_;
 473     my @missing = ();
 474
 475     # set mode on existing filehandles
 476     binmode(STDIN, ':utf8');
 477
 478     my $rc = GetOptions( $c,
 479                          'autoscrub|a',
 480                          'exception|x=s',
 481                          'output|o=s',
 482                          'nocollapse|n',
 483                          'renumber-from|rf=i',
 484                          'original-tag|ot=i',
 485                          'renumber-tag|rt=i',
 486                          'renumber-subfield|rt=i',
 487                          'trash|t=s',
 488                          'help|h',
 489                        );
 490     show_help() unless $rc;
 491     show_help() if ($c->{help});
 492
 493     # defaults
 494     $c->{output} = 'incoming.cleaned.marc.xml' unless defined $c->{output};
 495     $c->{exception} = 'incoming.exception.marc.xml' unless defined $c->{exception};
 496     $c->{'renumber-tag'} = 903 unless defined $c->{'renumber-tag'};
 497     $c->{'renumber-subfield'} = 'a' unless defined $c->{'renumber-subfield'};
 498
 499     my @keys = keys %{$c};
 500     show_help() unless (@ARGV and @keys);
 501     #for my $key ('runtype', 'tag', 'subfield', 'output', 'exception')
 502     #  { push @missing, $key unless $c->{$key} }
 503     #if (@missing) {
 504     #    print "Required option: ", join(', ', @missing), " missing!\n";
 505     #    show_help();
 506     #}
 507 }
 508
 509 sub show_help {
 510     print <<HELP;
 511 Usage is: $0 [OPTIONS] <filelist>
 512 Options
 513   --output     -o  Cleaned MARCXML output filename (default: incoming.cleaned.marc.xml)
 514   --exception  -x  Exception (dumped records) MARCXML filename (incoming.exception.marc.xml)
 515 HELP
 516 exit;
 517 }