utility methods for best-effort datatype casting
[migration-tools.git] / extract_holdings
index 29bd56d..58b7575 100755 (executable)
@@ -3,19 +3,118 @@ use strict;
 use warnings;
 
 use Getopt::Long;
-use Equinox::Migration::MapDrivenMARCXMLProc;
+use Equinox::Migration::MapDrivenMARCXMLProc 1.005;
 use Equinox::Migration::MARCXMLSampler;
 
+my $VERSION = '1.001';
+
+=pod
+
+TODO
+
+  * Have detail mode report on number of subfields per datafield
+
+=cut
 
 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});
+print "\n";
+
+#--------------------------
+
+sub extract_holdings {
+    my ($c) = @_;
+    print "Parsing records for extraction:\n";
+    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 }
+    }
 
+    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 my $holdidx ( @{ $rec->{tmap}{ $c->{holdings} } } ) {
+            # for each holdings tag in the record...
+            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
+                unless (defined $idx) {
+                    push @out, '';
+                    next;
+                }
+                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;
+                }
+                for my $sub ( sort keys %{$multis->{$othertag}} ) {
+                    for my $value ( @{$rec->{tags}[$idx]{multi}{$sub}} ) {
+                        my $fh = $MULTIFILE{"$othertag$sub"};
+                        print $fh join("\t", $rec->{egid}, $j, $value), "\n";
+                    }
+                }
+            }
+
+            # and dump it
+            print HOLDINGS "\n" unless $j;
+            print HOLDINGS join("\t", @out);
+            print HOLDINGS "\n";
+            $j++;
+        }
+        $i++;
+        print "\r$i $j";
+    }
+    print "\n";
+}
+
+#--------------------------
 
 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});
@@ -25,7 +124,6 @@ sub run_samples {
     } else {
         $s = Equinox::Migration::MARCXMLSampler->new( marcfile => $c->{marcfile} );
     }
-    $s->parse_records;
 
     dump_sample_overview($c, $s) if $c->{sample};
     dump_sample_detail($c, $s) if ($c->{samplemap} or $c->{samplestr});
@@ -35,21 +133,29 @@ 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";
-        for my $subkey (sort keys %{$tags->{$tag}}) {
+    for my $tag (sort keys %{ $tags }) {
+        print ">>>>> TAG $tag\n\n";
+        for my $subkey (sort keys %{ $tags->{$tag} }) {
             my $sub = $tags->{$tag}{$subkey};
-            print "  Subfield: $subkey\n";
-            print "  Sample:   '", $sub->{value}, "'\n";
-            print "  Count:    ", $sub->{count}, " in ", $sub->{tcnt}, " tags\n\n";
-            #print "(", int($sub->{count} / $sub->{rcnt}), "%)\n";
+            print "|| $subkey | ", $sub->{value}, " | ", 
+              $sub->{count}, "/", $sub->{tcnt}, " |  ||\n";
         }
+        print "\n";
     }
-    select STDOUT;
     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 dump_sample_overview {
@@ -62,15 +168,20 @@ sub dump_sample_overview {
 
     open SAMPLE, '>', ($c->{prefix} . "-HOLDINGS-OVERVIEW.txt");
     select SAMPLE;
-    print "FOUND TAGS (BY TAG)    FOUND TAGS (BY COUNT)\n";
-    print "-------------------    ---------------------\n";
+    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] }, "      ";
+          $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] }, "\n";
+          $tags->{ $tagsbycount[$i] };
+        print " (", sprintf("%03d", int($tags->{ $tagsbycount[$i] } / $count * 100)), "%)\n";
     }
     select STDOUT;
+    print "\n";
     close SAMPLE;
 }
 
@@ -87,17 +198,28 @@ sub initialize {
                          'sample|s',
                          'samplemap|sm=s',
                          'samplestr|ss=s',
-                         'marcfile|m=s',
-                         'ils|i=s',
-                         'library|l=s',
+                         'marcfile=s',
+                         'map|m=s',
+                         'holdings|h=i',
+                         'copyid|c=s',
                          'prefix|p=s',
-                         'help|h',
+                         '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};
+
+    if ($c->{prefix} and !$c->{marcfile}) {
+        $c->{marcfile} = $c->{prefix} . ".clean.marc.xml";
+    }
 
     my @keys = keys %{$c};
-    for my $key ('prefix', 'ils')
+    for my $key ('prefix', 'marcfile')
       { push @missing, $key unless $c->{$key} }
     if (@missing) {
         print "Required option: ", join(', ', @missing), " missing!\n";
@@ -108,14 +230,36 @@ sub initialize {
 }
 
 sub show_help {
+    my ($msg) = @_;
+    print "\nERROR - $msg\n" if $msg;
     print <<HELP;
-Usage is: extract_holdings -p PREFIX -m MAPFILE -i ILS [OPTIONS] <MARCXML>
-  prefix  p  Prefix string for output filenames
-  map     m  Subfield map file to use
-  ils     i  Legacy ILS name (affects SQL generation)
 
-  sample  s  Comma-delineated list of datafield tags to be sampled
-  library l  Legacy library name (affects SQL generation)
+Usage is: extract_holdings -p PREFIX -m MARCFILE [ARGUMENTS]
+
+REQUIRED ARGUMENTS
+  --prefix   -p  Prefix string for output filenames
+  --marcfile     MARCXML to use as source data
+                 Defaults to 'PREFIX.clean.marc.xml'
+
+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      -m   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 }