Open-ILS/src/perlmods/lib/OpenILS/Utils/MFHD.pm

   1 package MFHD;
   2 use strict;
   3 use warnings;
   4 use integer;
   5 use Carp;
   6 use DateTime::Format::Strptime;
   7 use Data::Dumper;
   8
   9 # for inherited methods to work properly, we need to force a
  10 # MARC::Record version greater than 2.0.0
  11 use MARC::Record "2.0.1";
  12 use base 'MARC::Record';
  13
  14 use OpenILS::Utils::MFHD::Caption;
  15 use OpenILS::Utils::MFHD::Holding;
  16
  17 sub new {
  18     my $proto = shift;
  19     my $class = ref($proto) || $proto;
  20     my $self  = shift;
  21
  22     $self->{_strp_date} = new DateTime::Format::Strptime(pattern => '%F');
  23
  24     $self->{_mfhd_CAPTIONS} = {};
  25     $self->{_mfhd_COMPRESSIBLE} = (substr($self->leader, 17, 1) =~ /[45]/);
  26
  27     foreach my $field ('853', '854', '855') {
  28         my $captions = {};
  29         foreach my $caption ($self->field($field)) {
  30             my $cap_id;
  31
  32             $cap_id = $caption->subfield('8') || '0';
  33
  34             if (exists $captions->{$cap_id}) {
  35                 carp "Multiple MFHD captions with label '$cap_id'";
  36             }
  37
  38             $captions->{$cap_id} = new MFHD::Caption($caption);
  39             if ($self->{_mfhd_COMPRESSIBLE}) {
  40                 $self->{_mfhd_COMPRESSIBLE} &&=
  41                   $captions->{$cap_id}->compressible;
  42             }
  43         }
  44         $self->{_mfhd_CAPTIONS}->{$field} = $captions;
  45     }
  46
  47     foreach my $field ('863', '864', '865') {
  48         my $holdings = {};
  49         my $cap_field;
  50
  51         ($cap_field = $field) =~ s/6/5/;
  52
  53         foreach my $hfield ($self->field($field)) {
  54             my ($linkage, $link_id, $seqno);
  55             my $holding;
  56
  57             $linkage = $hfield->subfield('8');
  58             ($link_id, $seqno) = split(/\./, $linkage);
  59
  60             if (!exists $holdings->{$link_id}) {
  61                 $holdings->{$link_id} = {};
  62             }
  63             $holding =
  64               new MFHD::Holding($seqno, $hfield,
  65                 $self->{_mfhd_CAPTIONS}->{$cap_field}->{$link_id});
  66             $holdings->{$link_id}->{$seqno} = $holding;
  67
  68             if ($self->{_mfhd_COMPRESSIBLE}) {
  69                 $self->{_mfhd_COMPRESSIBLE} &&= $holding->validate;
  70             }
  71         }
  72         $self->{_mfhd_HOLDINGS}->{$field} = $holdings;
  73     }
  74
  75     bless($self, $class);
  76     return $self;
  77 }
  78
  79 sub compressible {
  80     my $self = shift;
  81
  82     return $self->{_mfhd_COMPRESSIBLE};
  83 }
  84
  85 sub caption_link_ids {
  86     my $self  = shift;
  87     my $field = shift;
  88
  89     return sort keys %{$self->{_mfhd_CAPTIONS}->{$field}};
  90 }
  91
  92 # optional argument to get back a 'hashref' or an 'array' (default)
  93 sub captions {
  94     my $self  = shift;
  95     my $tag = shift;
  96     my $return_type = shift;
  97
  98     # TODO: add support for caption types as argument? (base, index, supplement)
  99     my @sorted_ids = $self->caption_link_ids($tag);
 100
 101     if (defined($return_type) and $return_type eq 'hashref') {
 102         my %captions;
 103         foreach my $link_id (@sorted_ids) {
 104             $captions{$link_id} = $self->{_mfhd_CAPTIONS}{$tag}{$link_id};
 105         }
 106         return \%captions;
 107     } else {
 108         my @captions;
 109         foreach my $link_id (@sorted_ids) {
 110             push(@captions, $self->{_mfhd_CAPTIONS}{$tag}{$link_id});
 111         }
 112         return @captions;
 113     }
 114 }
 115
 116 sub append_fields {
 117     my $self = shift;
 118
 119     my $field_count = $self->SUPER::append_fields(@_);
 120     if ($field_count) {
 121         foreach my $field (@_) {
 122             $self->_avoid_link_collision($field);
 123             my $field_type = ref $field;
 124             if ($field_type eq 'MFHD::Holding') {
 125                 $self->{_mfhd_HOLDINGS}{$field->tag}{$field->caption->link_id}{$field->seqno} = $field;
 126             } elsif ($field_type eq 'MFHD::Caption') {
 127                 $self->{_mfhd_CAPTIONS}{$field->tag}{$field->link_id} = $field;
 128             }
 129         }
 130         return $field_count;
 131     } else {
 132         return;
 133     }
 134 }
 135
 136 sub delete_field {
 137     my $self = shift;
 138     my $field = shift;
 139
 140     my $field_count = $self->SUPER::delete_field($field);
 141     if ($field_count) {
 142         my $field_type = ref($field);
 143         if ($field_type eq 'MFHD::Holding') {
 144             delete($self->{_mfhd_HOLDINGS}{$field->tag}{$field->caption->link_id}{$field->seqno});
 145         } elsif ($field_type eq 'MFHD::Caption') {
 146             delete($self->{_mfhd_CAPTIONS}{$field->tag}{$field->link_id});
 147         }
 148         return $field_count;
 149     } else {
 150         return;
 151     }
 152 }
 153
 154 sub insert_fields_before {
 155     my $self = shift;
 156     my $before = shift;
 157
 158     my $field_count = $self->SUPER::insert_fields_before($before, @_);
 159     if ($field_count) {
 160         foreach my $field (@_) {
 161             $self->_avoid_link_collision($field);
 162             my $field_type = ref $field;
 163             if ($field_type eq 'MFHD::Holding') {
 164                 $self->{_mfhd_HOLDINGS}{$field->tag}{$field->caption->link_id}{$field->seqno} = $field;
 165             } elsif ($field_type eq 'MFHD::Caption') {
 166                 $self->{_mfhd_CAPTIONS}{$field->tag}{$field->link_id} = $field;
 167             }
 168         }
 169         return $field_count;
 170     } else {
 171         return;
 172     }
 173 }
 174
 175 sub insert_fields_after {
 176     my $self = shift;
 177     my $after = shift;
 178
 179     my $field_count = $self->SUPER::insert_fields_after($after, @_);
 180     if ($field_count) {
 181         foreach my $field (@_) {
 182             $self->_avoid_link_collision($field);
 183             my $field_type = ref $field;
 184             if ($field_type eq 'MFHD::Holding') {
 185                 $self->{_mfhd_HOLDINGS}{$field->tag}{$field->caption->link_id}{$field->seqno} = $field;
 186             } elsif ($field_type eq 'MFHD::Caption') {
 187                 $self->{_mfhd_CAPTIONS}{$field->tag}{$field->link_id} = $field;
 188             }
 189         }
 190         return $field_count;
 191     } else {
 192         return;
 193     }
 194 }
 195
 196 sub _avoid_link_collision {
 197     my $self = shift;
 198     my $field = shift;
 199
 200     my $fieldref = ref($field);
 201     if ($fieldref eq 'MFHD::Holding') {
 202         my $seqno = $field->seqno;
 203         my $changed_seqno = 0;
 204         if (exists($self->{_mfhd_HOLDINGS}{$field->tag}{$field->caption->link_id}{$seqno})) {
 205             $changed_seqno = 1;
 206             do {
 207                 $seqno++;
 208             } while (exists($self->{_mfhd_HOLDINGS}{$field->tag}{$field->caption->link_id}{$seqno}));
 209         }
 210         $field->seqno($seqno) if $changed_seqno;
 211     } elsif ($fieldref eq 'MFHD::Caption') {
 212         my $link_id = $field->link_id;
 213         my $changed_link_id = 0;
 214         if (exists($self->{_mfhd_CAPTIONS}{$field->tag}{$link_id})) {
 215             $link_id++;
 216             $changed_link_id = 1;
 217             do {
 218                 $link_id++;
 219             } while (exists($self->{_mfhd_CAPTIONS}{$field->tag}{$link_id}));
 220         }
 221         $field->link_id($link_id) if $changed_link_id;
 222     }
 223 }
 224
 225 sub active_captions {
 226     my $self  = shift;
 227     my $tag = shift;
 228
 229     # TODO: add support for caption types as argument? (basic, index, supplement)
 230     my @captions;
 231     my @active_captions;
 232
 233     @captions = $self->captions($tag);
 234
 235     # TODO: for now, we will assume the last 85X field is active
 236     # and the rest are historical.  The standard is hazy about
 237     # how multiple active patterns of the same 85X type should be
 238     # handled.  We will, however, return as an array for future
 239     # use.
 240     push(@active_captions, $captions[-1]);
 241
 242     return @active_captions;
 243 }
 244
 245 sub holdings {
 246     my $self  = shift;
 247     my $field = shift;
 248     my $capid = shift;
 249
 250     return
 251       sort { $a->seqno <=> $b->seqno }
 252       values %{$self->{_mfhd_HOLDINGS}->{$field}->{$capid}};
 253 }
 254
 255 sub holdings_by_caption {
 256     my $self  = shift;
 257     my $caption = shift;
 258
 259     my $htag    = $caption->tag;
 260     my $link_id = $caption->link_id;
 261     $htag =~ s/^85/86/;
 262     return $self->holdings($htag, $link_id);
 263 }
 264
 265 sub _holding_date {
 266     my $self = shift;
 267     my $holding = shift;
 268
 269     return $self->{_strp_date}->parse_datetime($holding->chron_to_date);
 270 }
 271
 272 #
 273 # generate_predictions()
 274 # Accepts a hash ref of options initially defined as:
 275 # base_holding : reference to the holding field to predict from
 276 # num_to_predict : the number of issues you wish to predict
 277 # OR
 278 # end_holding : holding field ref, keep predicting until you meet or exceed it
 279 # OR
 280 # end_date : keep predicting until you exceed this
 281 #
 282 # The basic method is to first convert to a single holding if compressed, then
 283 # increment the holding and save the resulting values to @predictions.
 284 #
 285 # returns @predictions, an array of holding field refs (including end_holding
 286 # if applicable but NOT base_holding)
 287 #
 288 sub generate_predictions {
 289     my ($self, $options) = @_;
 290
 291     my $base_holding   = $options->{base_holding};
 292     my $num_to_predict = $options->{num_to_predict};
 293     my $end_holding    = $options->{end_holding};
 294     my $end_date       = $options->{end_date};
 295     my $max_to_predict = $options->{max_to_predict} || 10000; # fail-safe
 296
 297     if (!defined($base_holding)) {
 298         carp("Base holding not defined in generate_predictions, returning empty set");
 299         return ();
 300     }
 301     if ($base_holding->is_compressed) {
 302         carp("Ambiguous compressed base holding in generate_predictions, returning empty set");
 303         return ();
 304     }
 305     my $curr_holding = $base_holding->clone; # prevent side-effects
 306
 307     my @predictions;
 308
 309     if ($num_to_predict) {
 310         for (my $i = 0; $i < $num_to_predict; $i++) {
 311             push(@predictions, $curr_holding->increment->clone);
 312         }
 313     } elsif (defined($end_holding)) {
 314         $end_holding = $end_holding->clone; # prevent side-effects
 315         my $next_holding = $curr_holding->increment->clone;
 316         my $num_predicted = 0;
 317         while ($next_holding le $end_holding) {
 318             push(@predictions, $next_holding);
 319             $num_predicted++;
 320             if ($num_predicted >= $max_to_predict) {
 321                 carp("Maximum prediction count exceeded");
 322                 last;
 323             }
 324             $next_holding = $curr_holding->increment->clone;
 325         }
 326     } elsif (defined($end_date)) {
 327         my $next_holding = $curr_holding->increment->clone;
 328         my $num_predicted = 0;
 329         while ($self->_holding_date($next_holding) <= $end_date) {
 330             push(@predictions, $next_holding);
 331             $num_predicted++;
 332             if ($num_predicted >= $max_to_predict) {
 333                 carp("Maximum prediction count exceeded");
 334                 last;
 335             }
 336             $next_holding = $curr_holding->increment->clone;
 337         }
 338     }
 339
 340     return @predictions;
 341 }
 342
 343 #
 344 # create an array of compressed holdings from all holdings for a given caption,
 345 # compressing as needed
 346 #
 347 # Optionally you can skip sorting, but the resulting compression will be compromised
 348 # if the current holdings are out of order
 349 #
 350 # TODO: gap marking, gap preservation
 351 #
 352 # TODO: some of this could be moved to the Caption object to allow for
 353 # decompression in the absense of an overarching MFHD object
 354 #
 355 sub get_compressed_holdings {
 356     my $self = shift;
 357     my $caption = shift;
 358     my $opts = shift;
 359     my $skip_sort = $opts->{'skip_sort'};
 360
 361     # basic check for necessary pattern information
 362     if (!scalar keys %{$caption->pattern}) {
 363         carp "Cannot compress without pattern data, returning original holdings";
 364         return $self->holdings_by_caption($caption);
 365     }
 366
 367     # make sure none are compressed (except for open-ended)
 368     my @decomp_holdings;
 369     if ($skip_sort) {
 370         @decomp_holdings = $self->get_decompressed_holdings($caption, {'skip_sort' => 1, 'passthru_open_ended' => 1});
 371     } else {
 372         # sort for best algorithm
 373         @decomp_holdings = $self->get_decompressed_holdings($caption, {'dedupe' => 1, 'passthru_open_ended' => 1});
 374     }
 375
 376     return () if !@decomp_holdings;
 377
 378     # if first holding is open-ended, it 'includes' all the rest, so return
 379     if ($decomp_holdings[0]->is_open_ended) {
 380         return ($decomp_holdings[0]);
 381     }
 382
 383     my $runner = $decomp_holdings[0]->clone->increment;
 384     my $curr_holding = shift(@decomp_holdings);
 385     $curr_holding = $curr_holding->clone;
 386     my $seqno = 1;
 387     $curr_holding->seqno($seqno);
 388     my @comp_holdings;
 389     foreach my $holding (@decomp_holdings) {
 390         if ($runner eq $holding) {
 391             $curr_holding->extend;
 392             $runner->increment;
 393         } elsif ($holding->is_open_ended) { # special case, as it will always be the last
 394             if ($runner ge $holding->clone->compressed_to_first) {
 395                 $curr_holding->compressed_end();
 396             } else {
 397                 push(@comp_holdings, $curr_holding);
 398                 $curr_holding = $holding->clone;
 399                 $seqno++;
 400                 $curr_holding->seqno($seqno);
 401             }
 402             last;
 403         } elsif ($runner gt $holding) { # should not happen unless holding is not in series
 404             carp("Found unexpected holding, skipping");
 405         } else {
 406             push(@comp_holdings, $curr_holding);
 407
 408             my $loop_count = 0;
 409             (my $runner_dump = $runner->as_formatted) =~ s/\n\s+/*/gm; # logging
 410
 411             while ($runner le $holding) {
 412                 # Infinite loops used to happen here. As written today,
 413                 # ->increment() cannot be guaranteed to eventually falsify
 414                 # the condition ($runner le $holding) in certain cases.
 415
 416                 $runner->increment;
 417
 418                 if (++$loop_count >= 10000) {
 419                     (my $holding_dump = $holding->as_formatted) =~ s/\n\s+/*/gm;
 420
 421                     croak "\$runner<$runner_dump> didn't catch up with " .
 422                         "\$holding<$holding_dump> after 10000 increments";
 423                 }
 424             }
 425             $curr_holding = $holding->clone;
 426             $seqno++;
 427             $curr_holding->seqno($seqno);
 428         }
 429     }
 430     push(@comp_holdings, $curr_holding);
 431
 432     return @comp_holdings;
 433 }
 434
 435 #
 436 # create an array of single holdings from all holdings for a given caption,
 437 # decompressing as needed
 438 #
 439 # optional arguments:
 440 #    skip_sort: do not sort the returned holdings
 441 #    dedupe: remove any duplicate holdings from the set
 442 #    passthru_open_ended: open-ended compressed holdings cannot be logically
 443 #    decompressed (they are infinite); if set to true these holdings are passed
 444 #    thru rather than skipped
 445 # TODO: some of this could be moved to the Caption (and/or Holding) object to
 446 # allow for decompression in the absense of an overarching MFHD object
 447 #
 448 sub get_decompressed_holdings {
 449     my $self = shift;
 450     my $caption = shift;
 451     my $opts = shift;
 452     my $skip_sort = $opts->{'skip_sort'};
 453     my $dedupe = $opts->{'dedupe'};
 454     my $passthru_open_ended = $opts->{'passthru_open_ended'};
 455
 456     if ($dedupe and $skip_sort) {
 457         carp("Attempted deduplication without sorting, failure likely");
 458     }
 459
 460     my @holdings = $self->holdings_by_caption($caption);
 461
 462     return () if !@holdings;
 463
 464     my @decomp_holdings;
 465
 466     foreach my $holding (@holdings) {
 467         if (!$holding->is_compressed) {
 468             push(@decomp_holdings, $holding->clone);
 469         } elsif ($holding->is_open_ended) {
 470             if ($passthru_open_ended) {
 471                 push(@decomp_holdings, $holding->clone);
 472             } else {
 473                 carp("Open-ended holdings cannot be decompressed, skipping");
 474             }
 475         } else {
 476             my $base_holding = $holding->clone->compressed_to_first;
 477             my @new_holdings = $self->generate_predictions(
 478                 {'base_holding' => $base_holding,
 479                  'end_holding' => $holding->clone->compressed_to_last});
 480             push(@decomp_holdings, $base_holding, @new_holdings);
 481         }
 482     }
 483
 484     unless ($skip_sort) {
 485         my @temp_holdings = sort {$a cmp $b} @decomp_holdings;
 486         @decomp_holdings = @temp_holdings;
 487     }
 488
 489     my @return_holdings = (shift(@decomp_holdings));
 490     $return_holdings[0]->seqno(1);
 491     my $seqno = 2;
 492     foreach my $holding (@decomp_holdings) { # renumber sequence
 493         if ($holding eq $return_holdings[-1] and $dedupe) {
 494             carp("Found duplicate holding in decompression set, discarding");
 495             next;
 496         }
 497         $holding->seqno($seqno);
 498         $seqno++;
 499         push(@return_holdings, $holding);
 500     }
 501
 502     return @return_holdings;
 503 }
 504
 505 #
 506 # create an array of compressed holdings from all holdings for a given caption,
 507 # combining as needed
 508 #
 509 # NOTE: this sub is similar to, but much less aggressive/strict than
 510 # get_compressed_holdings(). Ultimately, get_compressed_holdings() might be
 511 # deprecated in favor of this
 512 #
 513 # TODO: gap marking, gap preservation
 514 #
 515 # TODO: some of this could be moved to the Caption (and/or Holding) object to
 516 # allow for combining in the absense of an overarching MFHD object
 517 #
 518 sub get_combined_holdings {
 519     my $self = shift;
 520     my $caption = shift;
 521
 522     my @holdings = $self->holdings_by_caption($caption);
 523     return () if !@holdings;
 524
 525     # basic check for necessary pattern information
 526     if (!scalar keys %{$caption->pattern}) {
 527         carp "Cannot combine without pattern data, returning original holdings";
 528         return @holdings;
 529     }
 530
 531     my @sorted_holdings = sort {$a cmp $b} @holdings;
 532
 533     my @combined_holdings = (shift(@sorted_holdings));
 534     my $seqno = 1;
 535     $combined_holdings[0]->seqno($seqno);
 536     foreach my $holding (@sorted_holdings) {
 537         # short-circuit: if we hit an open-ended holding,
 538         # it 'includes' all the rest, so just exit the loop
 539         if ($combined_holdings[-1]->is_open_ended) {
 540             last;
 541         } elsif ($holding eq $combined_holdings[-1]) {
 542             # duplicate, skip
 543             next;
 544         } else {
 545             # at this point, we know that $holding is gt $combined_holdings[-1]
 546             # we just need to figure out if they overlap or not
 547
 548             # first, get the end (or only) holding of [-1]
 549             my $last_holding_end = $combined_holdings[-1]->is_compressed ?
 550                 $combined_holdings[-1]->clone->compressed_to_last
 551                 : $combined_holdings[-1]->clone;
 552
 553             # next, get the end (or only) holding of the current
 554             # holding being considered
 555             my $holding_end;
 556             if ($holding->is_compressed) {
 557                 $holding_end = $holding->is_open_ended ?
 558                 undef
 559                 : $holding->clone->compressed_to_last;
 560             } else {
 561                 $holding_end = $holding;
 562             }
 563
 564             # next, make sure $holding isn't fully contained
 565             # if it is, skip it
 566             if ($holding_end and $holding_end le $last_holding_end) {
 567                 next;
 568             }
 569
 570             # now, get the beginning (or only) holding of $holding
 571             my $holding_start = $holding->is_compressed ?
 572                 $holding->clone->compressed_to_first
 573                 : $holding;
 574
 575             # see if they overlap
 576             if ($last_holding_end->increment ge $holding_start) {
 577                 # they overlap, combine them
 578                 $combined_holdings[-1]->compressed_end($holding_end);
 579             } else {
 580                 # no overlap, start a new group
 581                 $holding->seqno(++$seqno);
 582                 push(@combined_holdings, $holding);
 583             }
 584         }
 585     }
 586
 587     return @combined_holdings;
 588 }
 589
 590 ##
 591 ## close any open-ended holdings which are followed by another holding by
 592 ## combining them
 593 ##
 594 ## This needs more thought about concerning usability (e.g. should it be a
 595 ## mutator?), commenting out for now
 596 #sub _get_truncated_holdings {
 597 #    my $self = shift;
 598 #    my $caption = shift;
 599 #
 600 #    my @holdings = $self->holdings_by_caption($caption);
 601 #
 602 #    return () if !@holdings;
 603 #
 604 #    @holdings = sort {$a cmp $b} @holdings;
 605 #
 606 #    my $current_open_holding;
 607 #    my @truncated_holdings;
 608 #    foreach my $holding (@holdings) {
 609 #        if ($current_open_holding) {
 610 #            if ($holding->is_open_ended) {
 611 #                next; # consecutive open holdings are meaningless, as they are contained by the previous
 612 #            } elsif ($holding->is_compressed) {
 613 #                $current_open_holding->compressed_end($holding->compressed_to_last);
 614 #            } else {
 615 #                $current_open_holding->compressed_end($holding);
 616 #            }
 617 #            push(@truncated_holdings, $current_open_holding);
 618 #            $current_open_holding = undef;
 619 #        } elsif ($holding->is_open_ended) {
 620 #            $current_open_holding = $holding;
 621 #        } else {
 622 #            push(@truncated_holdings, $holding);
 623 #        }
 624 #    }
 625 #
 626 #    # catch possible open holding at end
 627 #    push(@truncated_holdings, $current_open_holding) if $current_open_holding;
 628 #
 629 #    my $seqno = 1;
 630 #    foreach my $holding (@truncated_holdings) { # renumber sequence
 631 #        $holding->seqno($seqno);
 632 #        $seqno++;
 633 #    }
 634 #
 635 #    return @truncated_holdings;
 636 #}
 637
 638 #
 639 # format_holdings(): Generate textual display of all holdings in record
 640 # for given type of caption (853--855) taking into account all the
 641 # captions, holdings statements, and textual
 642 # holdings.
 643 #
 644 # returns string formatted holdings as one very long line.
 645 # Caller must provide any label (such as "library has:" and insert
 646 # line breaks as appropriate.
 647
 648 # Translate caption field labels to the corresponding textual holdings
 649 # statement labels. That is, convert 853 "Basic bib unit" caption to
 650 # 866 "basic bib unit" text holdings label.
 651
 652 my %cap_to_txt = (
 653                   '853' => '866',
 654                   '854' => '867',
 655                   '855' => '868',
 656                  );
 657
 658 sub format_holdings {
 659     my $self = shift;
 660     my $field = shift;
 661     my $holdings_field;
 662     my @txt_holdings;
 663     my %txt_link_ids;
 664     my $holdings_stmt = '';
 665     my ($l, $start);
 666
 667     # convert caption field id to holdings field id
 668     ($holdings_field = $field) =~ s/5/6/;
 669
 670     # Textual holdings statements complicate the basic algorithm for
 671     # formatting the holdings: If there's a textual holdings statement
 672     # with the subfield "$80", then that overrides ALL the MFHD holdings
 673     # information and is all that is displayed. Otherwise, the textual
 674     # holdings statements will either replace some of the MFHD holdings
 675     # information, or supplement it, depending on the value of the
 676     # $8 linkage subfield.
 677
 678     if (defined $self->field($cap_to_txt{$field})) {
 679         @txt_holdings = $self->field($cap_to_txt{$field});
 680
 681         foreach my $txt (@txt_holdings) {
 682
 683             # if there's a $80 subfield, then we're done, it's
 684             # all the formatted holdings
 685             if ($txt->subfield('8') eq '0') {
 686                 # textual holdings statement that completely
 687                 # replaces MFHD holdings in 853/863, etc.
 688                 $holdings_stmt = $txt->subfield('a');
 689
 690                 if (defined $txt->subfield('z')) {
 691                     $holdings_stmt .= ' -- ' . $txt->subfield('z');
 692                 }
 693
 694                 printf("# format_holdings() returning %s txt holdings\n",
 695                        $cap_to_txt{$field});
 696                 return $holdings_stmt;
 697             }
 698
 699             # If there are non-$80 subfields in the textual holdings
 700             # then we need to keep track of the subfields, so we can
 701             # intersperse the textual holdings in with the the calculated
 702             # holdings from the 853/863 fields.
 703             foreach my $linkid ($txt->subfield('8')) {
 704                 $txt_link_ids{$linkid} = $txt;
 705             }
 706         }
 707     }
 708
 709     # Now loop through all the captions, finding the corresponding
 710     # holdings statements (either MFHD or textual), and build up the
 711     # complete formatted holdings statement. The textual holdings statements
 712     # have either the same link id field as a caption, which means that
 713     # the text holdings win, or they have ids that are interfiled with
 714     # the captions, which mean they go into the middle.
 715
 716     my @ids = sort($self->caption_link_ids($field), keys %txt_link_ids);
 717     foreach my $cap_id (@ids) {
 718         my $last_txt = undef;
 719
 720         if (exists $txt_link_ids{$cap_id}) {
 721             # there's a textual holding statement with this caption ID,
 722             # so just use that. This covers both the "replaces" and
 723             # the "supplements" holdings information options.
 724
 725             # a single textual holdings statement can replace multiple
 726             # captions. If the _last_ caption we saw had a textual
 727             # holdings statement, and this caption has the same one, then
 728             # we don't add the holdings again.
 729             if (!defined $last_txt || ($last_txt != $txt_link_ids{$cap_id})) {
 730                 my $txt = $txt_link_ids{$cap_id};
 731                 $holdings_stmt .= ',' if $holdings_stmt;
 732                 $holdings_stmt .= $txt->subfield('a');
 733                 if (defined $txt->subfield('z')) {
 734                     $holdings_stmt .= ' -- ' . $txt->subfield('z');
 735                 }
 736
 737                 $last_txt = $txt;
 738             }
 739             next;
 740         }
 741
 742         # We found a caption that doesn't have a corresponding textual
 743         # holdings statement, so reset $last_txt to undef.
 744         $last_txt = undef;
 745
 746         my @holdings = $self->holdings($holdings_field, $cap_id);
 747
 748         next unless scalar @holdings;
 749
 750         # XXX Need to format compressed holdings. see code in test.pl
 751         # for example. Try to do it without indexing?
 752         $holdings_stmt .= ',' if $holdings_stmt;
 753
 754         if ($self->compressible) {
 755             $start = $l = shift @holdings;
 756             $holdings_stmt .= $l->format;
 757
 758             while (my $h = shift @holdings) {
 759                 if (!$h->matches($l->next)) {
 760                     # this item is not part of the current run,
 761                     # close out the run and record this item
 762                     if ($l != $start) {
 763                         $holdings_stmt .= '-' . $l->format;
 764                     }
 765
 766                     $holdings_stmt .= ',' . $h->format;
 767                     $start = $h
 768                 } elsif (!scalar(@holdings) || defined($h->subfield('z'))) {
 769                     # This is the end of the holdings for this caption
 770                     # or this item has a public note that we want
 771                     # to display
 772                     $holdings_stmt .= '-' . $h->format;
 773                 }
 774
 775                 if (defined $h->subfield('z')) {
 776                     $holdings_stmt .= ' -- ' . $h->subfield('z');
 777                 }
 778
 779                 $l = $h;
 780             }
 781         } else {
 782             $holdings_stmt .= ',' if $holdings_stmt;
 783             $holdings_stmt .= (shift @holdings)->format;
 784             foreach my $h (@holdings) {
 785                 $holdings_stmt .= ',' . $h->format;
 786                 if (defined $h->subfield('z')) {
 787                     $holdings_stmt .= ' -- ' . $h->subfield('z');
 788                 }
 789             }
 790         }
 791     }
 792
 793     return $holdings_stmt;
 794 }
 795
 796 1;