#!/usr/bin/perl
+
+# Copyright 2009-2012, Equinox Software, Inc.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
require 5.10.0;
use strict;
use Term::ReadLine;
use Equinox::Migration::SimpleTagList;
-binmode STDOUT, ":utf8";
my $term = new Term::ReadLine 'yaz-cleanup';
my $OUT = $term->OUT || \*STDOUT;
+binmode STDOUT, ":utf8";
+binmode $OUT, ":utf8";
$| = 1;
# initialization and setup
-my $conf = {};
-initialize($conf);
+my $c = {};
+initialize($c);
# set up files, since everything appears to be in order
-my $marcfile = shift || 'incoming.marc.xml';
-open MARC, '<:utf8', $marcfile
+open MARC, '<:utf8', $c->{marcfile}
or die "Can't open input file $!\n";
-open my $NUMARC, '>:utf8', $conf->{output}
+open my $NUMARC, '>:utf8', $c->{output}
or die "Can't open output file $!\n";
open my $OLD2NEW, '>', 'old2new.map'
- if ($conf->{'renumber-from'} and $conf->{'original-subfield'});
+ if ($c->{'renumber-from'} and $c->{'original-tag'});
my $EXMARC = 'EX';
-print $NUMARC "<collection>\n";
+print $NUMARC "<collection xmlns=\"http://www.loc.gov/MARC21/slim\">\n";
-$conf->{totalrecs} = `grep -c '<record' $marcfile`;
-chomp $conf->{totalrecs};
-$conf->{percent} = 0;
+$c->{totalrecs} = `grep -c '<record' $c->{marcfile}`;
+chomp $c->{totalrecs};
+$c->{percent} = 0;
-my @record = (); # current record storage
-my %recmeta = (); # metadata about current record
-my $ptr = 0; # record index pointer
+my @record; # current record storage
+my %recmeta; # metadata about current record
+my $ptr = 0; # record index pointer
# this is the dispatch table which drives command selection in
# edit(), below
my $sidx = 0;
while ( buildrecord() ) {
- unless ($conf->{ricount} % 50) {
- $conf->{percent} = int(($conf->{ricount} / $conf->{totalrecs}) * 100);
- print "\rWorking (",$conf->{percent},"%) ", $spinner[$sidx];
+ unless ($c->{ricount} % 50) {
+ $c->{percent} = int(($c->{ricount} / $c->{totalrecs}) * 100);
+ print "\rWorking (",$c->{percent},"%) ", $spinner[$sidx];
$sidx = ($sidx == $#spinner) ? 0 : $sidx + 1;
}
$ptr = 0;
until ($ptr == $#record) {
# get datafield/tag data if we have it
- my $rc = stow_record_data();
- return $rc if $rc;
+ $rc = stow_record_data() if ($c->{'renumber-from'} and $c->{'original-tag'});
+ next if $rc;
# naked ampersands
if ($record[$ptr] =~ /&/ && $record[$ptr] !~ /&\w+?;/)
my $match = $1;
# tags must be numeric
if ($match =~ /\D/) {
- edit("Non-numerics in tag") unless $conf->{autoscrub};
+ edit("Non-numerics in tag") unless $c->{autoscrub};
next;
}
- # test for existing 901/903 unless we're autocleaning them
- unless ($conf->{'strip9'} or $conf->{'no-strip9'}) {
- if ($match == 901 or $match == 903) {
- edit("Incoming 901/903 found in data");
- next;
- }
- }
}
# subfields can't be non-alphanumeric
if ($record[$ptr] =~ /<subfield code="(.*?)"/) {
if ($1 =~ /\P{IsAlnum}/ or $1 eq '') {
- edit("Junk in subfield code/Null subfield code");
+ edit("Junk in subfield code/Null subfield code ($1)");
next;
}
}
- # subfields can't be non-alphanumeric
+ # subfields can't be larger than 1 char (technically you could make the MARC format accomodate that:)
if ($record[$ptr] =~ /<subfield code="(\w{2,})"/) {
edit("Subfield code larger than 1 char");
next;
write_record($NUMARC);
}
print $NUMARC "</collection>\n";
-print $OUT "\nDone. \n";
+print $OUT "\nDone. ",$c->{ricount}," in; ",$c->{rocount}," dumped \n";
#-----------------------------------------------------------------------------------
sub do_automated_cleanups {
$ptr = 0;
until ($ptr == $#record) {
+
# catch empty datafield elements
if ($record[$ptr] =~ m/<datafield tag="..."/) {
if ($record[$ptr + 1] =~ m|</datafield>|) {
my @a = @record[0 .. $ptr - 1];
my @b = @record[$ptr + 2 .. $#record];
@record = (@a, @b);
+ @a = undef; @b = undef;
message("Empty datafield scrubbed");
$ptr = 0;
next;
my @a = @record[0 .. $ptr - 1];
my @b = @record[$ptr + 1 .. $#record];
@record = (@a, @b);
+ @a = undef; @b = undef;
message("Empty subfield scrubbed");
$ptr = 0;
next;
message("Short leader padded");
}
}
+ if ($c->{'force-utf8'}) {
+ if ($record[$ptr] =~ m|<leader>(.........).(.+)</leader>|) {
+ $record[$ptr] = "<leader>$1a$2</leader>\n";
+ }
+ }
if ($record[$ptr] =~ m|<controlfield tag="008">(.+?)</control|) {
#pad short 008
my $content = $1;
message("Dollar sign corrected");
}
- # clean up tags with spaces in them
- $record[$ptr] =~ s/tag=" /tag="00/g;
- $record[$ptr] =~ s/tag=" /tag="0/g;
- $record[$ptr] =~ s/tag="-/tag="0/g;
- $record[$ptr] =~ s/tag="(\d\d) /tag="0$1/g;
+ # excessive trailing whitespace in subfield contents
+ if ($record[$ptr] =~ m|\s{10,}</subfield>|) {
+ $record[$ptr] =~ s|\s{10,}</subfield>|</subfield>|;
+ message("Trailing whitespace trimmed from subfield contents");
+ }
# automatable subfield maladies
- $record[$ptr] =~ s/code=" ">c/code="c">/;
- $record[$ptr] =~ s/code=" ">\$/code="c">\$/;
+ if ($record[$ptr] =~ /code=" ">c/) {
+ message('Fixing probable subfield c, scenario 1');
+ $record[$ptr] =~ s/code=" ">c/code="c">/;
+ }
+ if ($record[$ptr] =~ /code=" ">\$/) {
+ message('Fixing probable subfield c, scenario 2');
+ $record[$ptr] =~ s/code=" ">\$/code="c">\$/;
+ }
+
+ if ($c->{'fix-subfield'}) {
+ if ($record[$ptr] =~ /code="&">/) {
+ message('Fixing & for subfield code');
+ $record[$ptr] =~ s/code="&">/code="$c->{'fix-subfield'}">/;
+ }
+ if ($record[$ptr] =~ /code="(.*?\P{IsAlnum}.*?)">/) {
+ message("Fixing non-alphanumeric subfield code: $1 -> " . $c->{'fix-subfield'});
+ $record[$ptr] =~ s/code=".*?\P{IsAlnum}.*?">/code="$c->{'fix-subfield'}">/;
+ }
+ if ($record[$ptr] =~ /code="">/) {
+ message('Fixing null subfield code');
+ $record[$ptr] =~ s/code="">/code="$c->{'fix-subfield'}">/;
+ }
+ }
}
return 0;
}
sub stow_record_data {
# get tag data if we're looking at it
- if ($record[$ptr] =~ m/<datafield tag="(?<TAG>.{3})"/) {
- $recmeta{tag} = $+{TAG};
- $record[$ptr] =~ m/ind1="(?<IND1>.)"/;
- $recmeta{ind1} = $+{IND1} || '';
- $record[$ptr] =~ m/ind2="(?<IND2>.)"/;
- $recmeta{ind2} = $+{IND2} || '';
-
- unless (defined $recmeta{tag}) {
+ my $tag = 0;
+ if ($record[$ptr] =~ m/<(?:control|data)field tag="(.{3})"/) {
+ $recmeta{tag} = $1;
+ $tag = $recmeta{tag};
+ $record[$ptr] =~ m/ind1="(.)"/;
+ $recmeta{ind1} = $1 || '';
+ $record[$ptr] =~ m/ind2="(.)"/;
+ $recmeta{ind2} = $1 || '';
+
+ unless ($tag) {
message("Autokill record: no detectable tag");
dump_record("No detectable tag") ;
return 1;
}
# and since we are looking at a tag, see if it's the original id
- if ($conf->{'original-subfield'} and $recmeta{tag} == $conf->{'original-tag'}) {
- my $line = $record[$ptr]; my $lptr = $ptr;
- my $osub = $conf->{'original-subfield'};
- $recmeta{oid} = 'NONE';
-
- until ($line =~ m|</record>|) {
- if ($line =~ /<subfield code="$osub">(.+?)</)
- { $recmeta{oid} = $1 }
- $lptr++;
- $line = $record[$lptr];
+ if ($tag == $c->{'original-tag'}) {
+ my $oid = 0;
+ if ($tag < 10) {
+ # controlfield
+ if ($record[$ptr] =~ m|<controlfield tag="$tag">(.+?)</controlfield>|)
+ { $oid = $1; print $OLD2NEW "$oid\t", $recmeta{nid}, "\n" }
+ } elsif ($tag >= 10 and $c->{'original-subfield'}) {
+ # datafield
+ my $line = $record[$ptr]; my $lptr = $ptr;
+ my $osub = $c->{'original-subfield'};
+ # skim to end of this tag
+ until ($line =~ m|</datafield>|) {
+ if ($line =~ /<subfield code="$osub">(.+?)</)
+ { $oid = $1; print $OLD2NEW "$oid\t", $recmeta{nid}, "\n" }
+ $lptr++;
+ $line = $record[$lptr];
+ }
+ } else {
+ return 0;
}
- unless (defined $recmeta{oid}) {
+
+ # didn't find the old id!
+ unless ($oid) {
message("Autokill record: no oldid when old2new mapping requested");
dump_record("No old id found");
return 1;
}
+
+ # got it; write to old->new map file
+ if ($c->{'renumber-from'} and $c->{'original-subfield'}) {
+ }
+
}
}
return 0;
sub edit {
my ($msg) = @_;
- return if $conf->{trash}->has( $recmeta{tag} );
- $conf->{editmsg} = $msg;
+ return if $c->{trash}->has( $recmeta{tag} );
+ if ( $c->{fullauto} )
+ { dump_record($msg); return }
+
+ $c->{editmsg} = $msg;
print_fullcontext();
# stow original problem line
sub buildrecord {
my $l = '';
- $l = <MARC> while (defined $l and $l !~ /<record>/);
+ my $istrash = 0;
+ my $trash = $c->{trash};
+
+ $l = <MARC> while (defined $l and $l !~ /<record/);
return $l unless defined $l;
- @record = ();
- %recmeta = ();
- $conf->{ricount}++;
+ $c->{ricount}++;
+
+ for (keys %recmeta) { $recmeta{$_} = undef }
+ for (0 .. @record) { delete $record[$_] }
+
+ my $i = 0;
+ until ($l =~ m|</record>|) {
+ # clean up tags with spaces in them
+ $l =~ s/tag=" /tag="00/g;
+ $l =~ s/tag=" /tag="0/g;
+ $l =~ s/tag="-/tag="0/g;
+ $l =~ s/tag="(\d\d) /tag="0$1/g;
+
+ # excise unwanted tags
+ if ($istrash) {
+ $istrash = 0 if ($l =~ m|</datafield|);
+ $l = <MARC>;
+ next;
+ }
+ if ($l =~ m/<datafield tag="(.{3})"/) {
+ if ($trash->has($1) or ($c->{autoscrub} and $1 =~ /\D/))
+ { $istrash = 1; next }
+ }
+
+ push @record, $l;
+ $l = <MARC>;
+ $i++;
+ }
+
+ # add 903(?) with new record id
+ if ($c->{'renumber-from'}) {
+ $recmeta{nid} = $c->{'renumber-from'};
+ push @record, join('', ' <datafield tag="', $c->{'renumber-tag'},
+ '" ind1=" " ind2=" "> <subfield code="',
+ $c->{'renumber-subfield'},
+ '">',
+ $recmeta{nid},
+ "</subfield></datafield>\n");
+ $c->{'renumber-from'}++;
+ }
+ $i++;
- until ($l =~ m|</record>|)
- { push @record, $l; $l = <MARC>; }
push @record, $l;
return 1;
}
sub write_record {
my ($FH) = @_;
- my $trash = $conf->{trash};
if ($FH eq 'EX') {
$EXMARC = undef;
- open $EXMARC, '>:utf8', $conf->{exception}
+ open $EXMARC, '>:utf8', $c->{exception}
or die "Can't open exception file $!\n";
$FH = $EXMARC;
}
- $conf->{rocount}++ if ($FH eq $NUMARC);
print $FH '<!-- ', $recmeta{explanation}, " -->\n"
if(defined $recmeta{explanation});
- # excise unwanted tags
- if (defined $trash or $conf->{autoscrub}) {
- my @trimmed = ();
- my $istrash = 0;
- for my $line (@record) {
- if ($istrash) {
- $istrash = 0 if $line =~ m|</datafield|;
- next;
- }
- if ($line =~ m/<datafield tag="(.{3})"/) {
- my $tag = $1;
- if ($trash->has($tag) or ($conf->{autoscrub} and $tag =~ /\D/)) {
- $istrash = 1;
- next
- }
- }
- push @trimmed, $line;
- }
- @record = @trimmed;
- }
-
- # add 903(?) with new record id
- my $renumber = '';
- if ($conf->{'renumber-from'}) {
- $recmeta{nid} = $conf->{'renumber-from'};
- $renumber = join('', ' <datafield tag="', $conf->{'renumber-tag'},
- '" ind1=" " ind2=" "> <subfield code="',
- $conf->{'renumber-subfield'},
- '">', $recmeta{nid}, "</subfield></datafield>\n");
- my @tmp = @record[0 .. $#record - 1];
- my $last = $record[$#record];
- @record = (@tmp, $renumber, $last);
- $conf->{'renumber-from'}++;
- }
-
# scrub newlines (unless told not to or writing exception record)
- unless ($conf->{nocollapse} or $FH eq $EXMARC)
+ unless ($c->{nocollapse} or $FH eq $EXMARC)
{ s/\n// for (@record) }
- # write to old->new map file if needed
- if ($conf->{'renumber-from'} and $conf->{'original-subfield'}) {
- print $OLD2NEW $recmeta{oid}, "\t", $recmeta{nid}, "\n"
- }
-
# actually write the record
print $FH @record,"\n";
+ # increment output record count (if not exception)
+ $c->{rocount}++ if ($FH eq $EXMARC);
+
# if we were dumping to exception file, nuke the record and set ptr
# to terminate processing loop
@record = ('a');
sub print_fullcontext {
print $OUT "\r", ' ' x 72, "\n";
- print $OUT $conf->{editmsg},"\n";
+ print $OUT $c->{editmsg},"\n";
print $OUT "\r Tag:",$recmeta{tag}, " Ind1:'",
$recmeta{ind1},"' Ind2:'", $recmeta{ind2}, "'";
- print $OUT " @ ", $conf->{ricount}, "/", $conf->{rocount} + 1;
+ print $OUT " @ ", $c->{ricount}, "/", $c->{totalrecs};
print_context();
return 0;
}
sub print_context {
- my $upper = int($conf->{window} / 2) + 1;
- my $lower = int($conf->{window} / 2) - 1;
+ my $upper = int($c->{window} / 2) + 1;
+ my $lower = int($c->{window} / 2) - 1;
my $start = ($ptr - $upper < 0) ? 0 : $ptr - $upper;
my $stop = ($ptr + $lower > $#record) ? $#record : $ptr + $lower;
print $OUT "\n";
sub message {
my ($msg) = @_;
- print $OUT "\r$msg at ",$conf->{ricount},"/",$conf->{rocount} + 1,"\n";
+ print $OUT "\r$msg at ",$c->{ricount},"/",$c->{totalrecs}, "\n";
}
#-----------------------------------------------------------------------------------
$recmeta{prevline} = $record[$ptr];
$record[$ptr] =~ s/$from/$to/;
+ $ofrom = undef; $to = undef; $from = undef;
print_context();
return 0;
}
my $temp = $record[$ptr];
$record[$ptr] = $recmeta{prevline};
$recmeta{prevline} = $temp;
+ $temp = undef;
print_context();
return 0;
}
my @a = @record[0 .. $ptr - 1];
my @b = @record[$ptr + 1 .. $#record];
@record = (@a, @b);
+ @a = undef; @b = undef;
print_context();
return 0;
}
{ print $OUT "No killed line to yank\n"; return }
my @a = @record[0 .. $ptr - 1];
my @b = @record[$ptr .. $#record];
- @record = (@a, $conf->{killline}, @b);
+ @record = (@a, $c->{killline}, @b);
+ @a = undef; @b = undef;
print_context();
return 0;
}
sub dump_record {
my (@explanation) = @_;
- print $OUT @explanation;
- $recmeta{explanation} = join(' ', 'Tag', $recmeta{tag}, @explanation);
+ $recmeta{explanation} = join(' ', 'DUMPING RECORD: Tag', $recmeta{tag}, @explanation);
+ message( $recmeta{explanation} );
write_record($EXMARC);
return 1;
}
sub commit_edit { return 1 }
sub widen_window {
- if ($conf->{window} == 15)
+ if ($c->{window} == 15)
{ print $OUT "Window can't be bigger than 15 lines\n"; return }
- $conf->{window} += 2;
+ $c->{window} += 2;
print_context;
}
sub narrow_window {
- if ($conf->{window} == 5)
+ if ($c->{window} == 5)
{ print $OUT "Window can't be smaller than 5 lines\n"; return }
- $conf->{window} -= 2;
+ $c->{window} -= 2;
print_context;
}
my $rc = GetOptions( $c,
'autoscrub|a',
+ 'fullauto',
'exception|x=s',
'output|o=s',
+ 'marcfile|m=s',
'prefix|p=s',
'nocollapse|n',
'renumber-from|rf=i',
'renumber-subfield|rs=s',
'original-tag|ot=i',
'original-subfield|os=s',
+ 'fix-subfield|fs=s',
+ 'force-utf8',
'script',
- 'strip9',
'no-strip9',
'trashfile|t=s',
'trashhelp',
show_trashhelp() if ($c->{trashhelp});
# defaults
- my $pfx = $c->{prefix} // "bibs";
- $c->{output} = join('.',$c->{prefix},'clean','marc','xml');
- $c->{exception} = join('.',$c->{prefix},'exception','marc','xml');
+ my $pfx = defined($c->{prefix}) ? $c->{prefix} : "bibs";
+ $c->{ricount} = 0;
+ $c->{rocount} = 0;
$c->{'renumber-tag'} = 903 unless defined $c->{'renumber-tag'};
$c->{'renumber-subfield'} = 'a' unless defined $c->{'renumber-subfield'};
- $c->{window} = 5;
+ $c->{window} = 9;
+ if ($c->{prefix}) {
+ $c->{output} = join('.',$c->{prefix},'clean','marc','xml')
+ unless $c->{output};
+ $c->{exception} = join('.',$c->{prefix},'exception','marc','xml')
+ unless $c->{exception};
+ $c->{marcfile} = $c->{prefix} . '.marc.xml'
+ unless $c->{marcfile};
+ }
+ show_help() unless ($c->{marcfile} and $c->{output});
if ($c->{trashfile}) {
- $c->{trash} = Equinox::Migration::SimpleTagList->new($conf->{trashfile})
+ $c->{trash} = Equinox::Migration::SimpleTagList->new(file => $c->{trashfile})
} else {
$c->{trash} = Equinox::Migration::SimpleTagList->new;
}
- # remove original id sequence tag from trash hash if we know it
- $c->{trash}->remove_tag($c->{'original-tag'})
- if ( $c->{'original-tag'} and $c->{trash}->has($c->{'original-tag'}) );
-
- # autotrash 901, 903 if strip-nines
- if ($c->{'strip9'}) {
+ # autotrash 901, 903 unless no strip-nines
+ unless ($c->{'no-strip9'}) {
$c->{trash}->add_tag(901);
$c->{trash}->add_tag(903);
}
-
- my @keys = keys %{$c};
- show_help() unless (@ARGV and @keys);
+ # remove original id sequence tag from trash hash if we know it
+ $c->{trash}->remove_tag($c->{'original-tag'})
+ if ( $c->{'original-tag'} and $c->{trash}->has($c->{'original-tag'}) );
}
sub show_help {
print <<HELP;
-Usage is: marc-cleanup [OPTIONS] <filelist>
+Usage is: marc_cleanup [OPTIONS] <filelist>
Options
--output -o Cleaned MARCXML output filename
--exception -x Exception (dumped records) MARCXML filename
or
- --prefix=<PREFIX>> -p Shared prefix for output/exception files. Will produce
+ --prefix=<PREFIX> -p Shared prefix for output/exception files. Will produce
PREFIX.clean.marc.xml and PREFIX.exception.marc.xml
+ --marcfile -m Input filename. Defaults to PREFIX.marc.xml
+
--renumber-from -rf Begin renumbering id sequence with this number
--renumber-tag -rt Tag to use in renumbering (default: 903)
--renumber-subfield -rs Subfield code to use in renumbering (default: a)
and renumbering is in effect, an old-to-new mapping
file (old2new.map) will be generated.
- --autoscrub -a Automatically remove non-numeric tags in data
- --nocollapse -n Don't compress records to one line on output
- --strip9 Automatically remove any existing 901/903 tags in data
- --no-strip9 Don't complain about 901/903 tags in data
- --trashfile -t File containing trash tag data (see --trashhelp)
+ --force-utf8 Rewrite each record so that they describe themselves as
+ UTF-8 encoded
+ --autoscrub -a Automatically remove non-numeric tags in data
+ --fix-subfield -fs Subfield code to use in place of non-alphanumeric
+ or empty subfield codes
+ --nocollapse -n Don't compress records to one line on output
+ --no-strip9 Don't autoremove 901/903 tags in data
+ --trashfile -t File containing trash tag data (see --trashhelp)
+ --fullauto No manual edits. All problematic records dumped to
+ exception file.
- --script Store human-initiated ops in scriptfile (.mcscript)
- Not yet implemented
HELP
exit;
}
projects / migration-tools.git / blobdiff