redoing previous changes
[migration-tools.git] / extract_holdings
index 8415c6a..27cf58a 100755 (executable)
 use strict;
 use warnings;
 
-use XML::Twig;
-use YAML;
-use JSON;
+use Getopt::Long;
+use Equinox::Migration::MapDrivenMARCXMLProc 1.003;
+use Equinox::Migration::MARCXMLSampler;
 
-my $marcxml = shift;
+my $VERSION = '1.001';
 
-open HOLDINGS, '>', "holdings";
-open X, '>', "holdings.x";
-open Z, '>', "holdings.z";
-open ALL852, '>', "holdings.all852";
+=pod
 
-my $holdings = {};
-my $copyid = 0;
-my %all852 = ( x => {}, z => {} ); # hash of all subfields in all 852s
+TODO
 
-my $t = XML::Twig->new( twig_handlers => { record => \&record } );
-$t->parsefile($marcxml);
-#print ALL852 to_json(\%all852);
-print ALL852 Dump(%all852);
+  * Have detail mode report on number of subfields per datafield
 
-sub record {
-    my($t, $r)= @_;
-    $holdings = { copies => [] };
+=cut
 
-    my @dfields = $r->children('datafield');
-    for my $d (@dfields) {
-        process_datafields($d) 
+my $c = initialize();
+$| = 1;
+
+# run samples if we've been asked for them
+run_samples($c) if ($c->{sample} or $c->{samplemap} or $c->{samplestr});
+extract_holdings($c) if ($c->{map});
+
+#--------------------------
+
+sub extract_holdings {
+    my ($c) = @_;
+    print "Parsing records for extraction... ";
+    my $m = Equinox::Migration::MapDrivenMARCXMLProc->new( marcfile => $c->{marcfile},
+                                                           mapfile  => $c->{map},
+                                                           verbose  => 1,
+                                                         );
+    print "Writing holdings to output file(s)...\n";
+    # open main holdings file
+    open HOLDINGS, '>', ($c->{prefix} . "-HOLDINGS.pg");
+    # create multi files
+    my $multis = $m->get_multis;
+    my %MULTIFILE = ();
+    for my $t ( keys %{$multis} ) {
+        for my $s ( keys %{$multis->{$t}}) 
+          { open my $fh, ">", ($c->{prefix} . "-HOLDINGS-MULT-$t$s.pg"); $MULTIFILE{"$t$s"} = $fh }
     }
 
-    for my $copy (@{$holdings->{copies}})
-      { print_reports($copy) }
-    $r->purge;
+    my $i = 0; # record counter
+    my $j = 0; # holdings counter
+
+    while (  $m->{data}{recs}[$i] ) {
+        print HOLDINGS "BEGIN;\n\negid, hseq, " unless $j;
+        my $rec = $m->{data}{recs}[$i];
+        my $k = 0; # holding-within-record pointer
+        # for each holdings tag in the record...
+        while ( defined $rec->{tmap}{ $c->{holdings} }[$k] ) {
+            my $holdidx = $rec->{tmap}{ $c->{holdings} }[$k];
+            my $tagid = $rec->{tags}[$holdidx]{tag};
+            $k++;
+
+            my @out = ();            # clear the output buffer
+            push @out, $rec->{egid}; # slug in the egid first thing
+            push @out, $j;           # holding seq goes next
+
+            # grab the unary mappings and slug 'em in
+            for my $sub ( sort keys %{$rec->{tags}[$holdidx]{uni}} ) {
+                push @out, $rec->{tags}[$holdidx]{uni}{$sub};
+                print HOLDINGS "l_", $m->name($tagid, $sub),", " unless $j;
+            }
+
+            # handle holdings multis
+            for my $sub ( sort keys %{$multis->{$tagid}} ) {
+                for my $value ( @{$rec->{tags}[$holdidx]{multi}{$sub}} ) {
+                  my $fh = $MULTIFILE{"$tagid$sub"};
+                  print $fh join("\t", $rec->{egid}, $j, $value), "\n";
+              }
+            }
+
+
+            # now get everything else in the mapping
+            for my $othertag ( sort keys %{$rec->{tmap}} ) {
+                next if $othertag eq $c->{holdings};  # ignoring the holdings, o'course
+                my $idx = $rec->{tmap}{$othertag}[0]; # get index into tags struct
+                for my $sub ( sort keys %{$rec->{tags}[$idx]{uni}} ) {
+                    push @out, $rec->{tags}[$idx]{uni}{$sub};
+                    print HOLDINGS "l_", $m->name($rec->{tags}[$idx]{tag}, $sub), ", "
+                      unless $j;
+                }
+            }
+
+            # and dump it
+            print HOLDINGS "\n" unless $j;
+            print HOLDINGS join("\t", @out);
+            print HOLDINGS "\n";
+            $j++;
+
+            @out = undef;
+        }
+        $i++;
+        print "\r$i";
+    }
+    print "\n";
 }
 
-sub process_datafields {
-    my ($d) = @_;
-    # get 903
-    if ($d->{'att'}->{'tag'} == 903) {
-        my $s = $d->first_child('subfield');
-        $holdings->{id} = $s->text;;
+#--------------------------
+
+sub run_samples {
+    my ($c) = @_;
+    my $s;
+    print "Parsing records for sampling... ";
+    if ($c->{samplemap}) {
+        $s = Equinox::Migration::MARCXMLSampler->new( marcfile => $c->{marcfile},
+                                                      mapfile  => $c->{samplemap});
+    } elsif ($c->{samplestr}) {
+        $s = Equinox::Migration::MARCXMLSampler->new( marcfile  => $c->{marcfile},
+                                                      mapstring => $c->{samplestr});
+    } else {
+        $s = Equinox::Migration::MARCXMLSampler->new( marcfile => $c->{marcfile} );
     }
 
-    # and holdings data
-    if ($d->{'att'}->{'tag'} == 852) {
-        push @{$holdings->{copies}}, { x =>[], z => [] };
-        $holdings->{copies}[-1]{copyid} = $copyid;
-        my @subs = $d->children('subfield');
-        for my $s (@subs) 
-          { process_subs($s) }
-        $copyid++;
+    dump_sample_overview($c, $s) if $c->{sample};
+    dump_sample_detail($c, $s) if ($c->{samplemap} or $c->{samplestr});
+}
+
+sub dump_sample_detail {
+    my ($c, $s) = @_;
+    my $tags = $s->{data}{samp};
+    my $count = $s->{data}{rcnt};
+    my $scnt  = $s->{data}{scnt};
+
+    open DETAIL, '>', ($c->{prefix} . "-HOLDINGS-DETAIL.txt");
+    select DETAIL;
+    for my $tag (sort keys %{ $tags }) {
+        print ">>>>> TAG $tag\n\n";
+        for my $subkey (sort keys %{ $tags->{$tag} }) {
+            my $sub = $tags->{$tag}{$subkey};
+            print "|| $subkey | ", $sub->{value}, " | ", 
+              $sub->{count}, "/", $sub->{tcnt}, " |  ||\n";
+        }
+        print "\n";
     }
+    close DETAIL;
+    open SCOUNT, '>', ($c->{prefix} . "-HOLDINGS-SUBCOUNTS.txt");
+    select SCOUNT;
+    for my $tag (sort keys %{ $scnt }) {
+        print ">>>>> TAG $tag\n\n";
+        for my $len (sort keys %{ $scnt->{$tag} }) 
+          { print "|| $len | ", $scnt->{$tag}{$len}, " ||\n" }
+        print "\n";
+    }
+    select STDOUT;
 }
 
-sub process_subs {
-    my ($s) = @_;
-    my $copy = $holdings->{copies}[-1];
+sub dump_sample_overview {
+    my ($c, $s) = @_;
+    my $tags = $s->{data}{tags};
+    my $count = $s->{data}{rcnt};
 
-    my $code = $s->{'att'}->{'code'};
-    my $value = $s->text;
+    my @tagsbyname  = sort keys %{$tags};
+    my @tagsbycount = reverse sort { $tags->{$a} <=> $tags->{$b} } keys %{$tags};
 
-    if ($code eq 'x' or $code eq 'z') {
-        push @{$copy->{$code}}, $value;
-        my ($k,$v) = split /:/, $value;
-        $all852{$code}{$k} = $v;
-    } else {        
-        $copy->{$code} = $value;
-        $all852{$code} = $value;
+    open SAMPLE, '>', ($c->{prefix} . "-HOLDINGS-OVERVIEW.txt");
+    select SAMPLE;
+    print "SAMPLE REPORT FOR ", $c->{prefix},": $count records\n\n";
+    print "FOUND TAGS (BY TAG)           FOUND TAGS (BY COUNT)\n";
+    print "------------------------      --------------------------\n";
+    for my $i (0 .. @tagsbyname - 1) {
+        print $tagsbyname[$i], (" " x (14 - length $tags->{ $tagsbyname[$i] })),
+          $tags->{ $tagsbyname[$i] };
+        print " (", sprintf("%03d", int($tags->{ $tagsbyname[$i] } / $count * 100)), "%)";
+        print "      ";
+        print $tagsbycount[$i], (" " x (16 - length $tags->{ $tagsbycount[$i] })),
+          $tags->{ $tagsbycount[$i] };
+        print " (", sprintf("%03d", int($tags->{ $tagsbycount[$i] } / $count * 100)), "%)\n";
     }
+    select STDOUT;
+    print "\n";
+    close SAMPLE;
 }
 
-sub print_reports {
-    my ($copy) = @_;
-    my $note = 0;
-    for (@{$copy->{x}}) {
-        print X join("\t", $holdings->{id}, $copy->{copyid}, $note, $_), "\n";
-        $note++;
-    }
-    $note = 0;
-    for (@{$copy->{z}}) {
-        print Z join("\t", $holdings->{id}, $copy->{copyid}, $note, $_), "\n";
-        $note++;
+#--------------------------
+
+sub initialize {
+    my $c = {};
+    my @missing = ();
+
+    # set mode on existing filehandles
+    binmode(STDIN, ':utf8');
+
+    my $rc = GetOptions( $c,
+                         'sample|s',
+                         'samplemap|sm=s',
+                         'samplestr|ss=s',
+                         'marcfile|m=s',
+                         'map=s',
+                         'holdings|h=i',
+                         'copyid|c=s',
+                         'prefix|p=s',
+                         'version|v',
+                         'help',
+                       );
+    show_help() unless $rc;
+    show_help() if ($c->{help});
+    show_help("Nothing to do!")
+      unless ($c->{map} or $c->{sample} or $c->{samplemap} or $c->{samplestr});
+    show_help("map, holdings, and copyid must be specified together!")
+      if ($c->{map} and !($c->{holdings} and $c->{copyid}));
+    show_version() if $c->{version};
+
+    my @keys = keys %{$c};
+    for my $key ('prefix', 'marcfile')
+      { push @missing, $key unless $c->{$key} }
+    if (@missing) {
+        print "Required option: ", join(', ', @missing), " missing!\n";
+        show_help();
     }
-    print HOLDINGS join("\t", $holdings->{id}, $copy->{copyid},
-                        $copy->{b}, $copy->{p}, $copy->{h}, $copy->{9}), "\n";
+
+    return $c;
+}
+
+sub show_help {
+    my ($msg) = @_;
+    print "\nERROR - $msg\n" if $msg;
+    print <<HELP;
+
+Usage is: extract_holdings -p PREFIX -m MARCFILE [ARGUMENTS]
+
+REQUIRED ARGUMENTS
+  --prefix   -p  Prefix string for output filenames
+  --marcfile -m  MARCXML to use as source data
+
+SAMPLING ARGUMENTS
+  --sample    -s   Generate a report of all tags in the MARC data
+  --samplemap -sm  Specify a E::M::STL map file which will be used to generate
+                   subfield breakdown reports about specific tags in the MARC
+                   data
+  --samplestr -ss  As above, but with a one-liner map specified on the command
+                   line as a string (e.g. '-ss "852 999"')
+
+  If --samplemap and --samplestr are both specified, --samplemap wins.
+
+HOLDINGS EXTRACTION ARGUMENTS
+  --map          E::M::SM map file which will be used to extract holdings data
+                 from the input MARC file
+  --holdings -h  Specifies actual holdings tag
+  --copyid   -c  Specifies subfield of holdings with unique copy identifier
+
+  Both these must be given together.
+HELP
+    exit;
 }
+
+sub show_version { print "extract_holdings v$VERSION\n"; exit }