Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Record.pm

   1 package OpenILS::WWW::EGCatLoader;
   2 use strict; use warnings;
   3 use Apache2::Const -compile => qw(OK DECLINED FORBIDDEN HTTP_GONE HTTP_INTERNAL_SERVER_ERROR REDIRECT HTTP_BAD_REQUEST HTTP_NOT_FOUND);
   4 use OpenSRF::Utils::Logger qw/$logger/;
   5 use OpenILS::Utils::CStoreEditor qw/:funcs/;
   6 use OpenILS::Utils::Fieldmapper;
   7 use OpenILS::Application::AppUtils;
   8 use Net::HTTP::NB;
   9 use IO::Select;
  10 my $U = 'OpenILS::Application::AppUtils';
  11
  12 our $ac_types = ['toc',  'anotes', 'excerpt', 'summary', 'reviews'];
  13
  14 # context additions:
  15 #   record : bre object
  16 sub load_record {
  17     my $self = shift;
  18     my %kwargs = @_;
  19     my $ctx = $self->ctx;
  20     $ctx->{page} = 'record';
  21
  22     $self->timelog("load_record() began");
  23
  24     my $rec_id = $ctx->{page_args}->[0];
  25
  26     return Apache2::Const::HTTP_BAD_REQUEST
  27         unless $rec_id and $rec_id =~ /^\d+$/;
  28
  29     $self->added_content_stage1($rec_id);
  30     $self->timelog("past added content stage 1");
  31
  32     my $org = $self->_get_search_lib();
  33     my $org_name = $ctx->{get_aou}->($org)->shortname;
  34     my $pref_ou = $self->_get_pref_lib();
  35     my $depth = $self->cgi->param('depth');
  36     $depth = $ctx->{get_aou}->($org)->ou_type->depth
  37         unless defined $depth; # can be 0
  38
  39     my $copy_depth = $self->cgi->param('copy_depth');
  40     $copy_depth = $depth unless defined $copy_depth; # can be 0
  41     $self->ctx->{copy_depth} = $copy_depth;
  42
  43     my $copy_limit = int($self->cgi->param('copy_limit') || 10);
  44     my $copy_offset = int($self->cgi->param('copy_offset') || 0);
  45
  46     $self->get_staff_search_settings;
  47     if ($ctx->{staff_saved_search_size}) {
  48         $ctx->{saved_searches} = ($self->staff_load_searches)[1];
  49     }
  50     $self->timelog("past staff saved searches");
  51
  52     $self->fetch_related_search_info($rec_id) unless $kwargs{no_search};
  53     $self->timelog("past related search info");
  54
  55     # Check for user and load lists and prefs
  56     if ($self->ctx->{user}) {
  57         $self->_load_lists_and_settings;
  58         $self->timelog("load user lists and settings");
  59     }
  60
  61     # run copy retrieval in parallel to bib retrieval
  62     # XXX unapi
  63     my $cstore = OpenSRF::AppSession->create('open-ils.cstore');
  64     my $copy_rec = $cstore->request(
  65         'open-ils.cstore.json_query.atomic',
  66         $self->mk_copy_query($rec_id, $org, $copy_depth, $copy_limit, $copy_offset, $pref_ou)
  67     );
  68
  69     if ($self->cgi->param('badges')) {
  70         my $badges = $self->cgi->param('badges');
  71         $badges = $badges ? [split(',', $badges)] : [];
  72         $badges = [grep { /^\d+$/ } @$badges];
  73         if (@$badges) {
  74             $self->ctx->{badge_scores} = $cstore->request(
  75                 'open-ils.cstore.direct.rating.record_badge_score.search.atomic',
  76                 { record => $rec_id, badge => $badges },
  77                 { flesh => 1, flesh_fields => { rrbs => ['badge'] } }
  78             )->gather(1);
  79         }
  80     } else {
  81         $self->ctx->{badge_scores} = [];
  82     }
  83
  84     # find foreign copy data
  85     my $peer_rec = $U->simplereq(
  86         'open-ils.search',
  87         'open-ils.search.peer_bibs', $rec_id );
  88
  89     $ctx->{foreign_copies} = $peer_rec;
  90
  91     my (undef, @rec_data) = $self->get_records_and_facets([$rec_id], undef, {
  92         flesh => '{holdings_xml,bmp,mra,acp,acnp,acns}',
  93         site => $org_name,
  94         depth => $depth,
  95         pref_lib => $pref_ou
  96     });
  97
  98     $self->timelog("past get_records_and_facets()");
  99     $ctx->{bre_id} = $rec_data[0]->{id};
 100     $ctx->{marc_xml} = $rec_data[0]->{marc_xml};
 101
 102     $ctx->{copies} = $copy_rec->gather(1);
 103
 104     # Add public copy notes to each copy - and while we're in there, grab peer bib records
 105     my %cached_bibs = ();
 106     foreach my $copy (@{$ctx->{copies}}) {
 107         $copy->{notes} = $U->simplereq(
 108             'open-ils.circ',
 109             'open-ils.circ.copy_note.retrieve.all',
 110             {itemid => $copy->{id}, pub => 1 }
 111         );
 112         $self->timelog("past copy note retrieval call");
 113         $copy->{peer_bibs} = $U->simplereq(
 114             'open-ils.search',
 115             'open-ils.search.multi_home.bib_ids.by_barcode',
 116             $copy->{barcode}
 117         );
 118         $self->timelog("past peer bib id retrieval");
 119         my @peer_marc;
 120         foreach my $bib (@{$copy->{peer_bibs}}) {
 121             next if $bib eq $ctx->{bre_id};
 122             next if $cached_bibs{$bib};
 123             my (undef, @peer_data) = $self->get_records_and_facets(
 124                 [$bib], undef, {
 125                     flesh => '{}',
 126                     site => $org_name,
 127                     depth => $depth,
 128                     pref_lib => $pref_ou
 129             });
 130             $cached_bibs{$bib} = 1;
 131             #$copy->{peer_bib_marc} = $peer_data[0]->{marc_xml};
 132             push @peer_marc, $peer_data[0]->{marc_xml};
 133             $self->timelog("fetched peer bib record $bib");
 134         }
 135         $copy->{peer_bib_marc} = \@peer_marc;
 136     }
 137
 138     $self->timelog("past store copy retrieval call");
 139     $ctx->{copy_limit} = $copy_limit;
 140     $ctx->{copy_offset} = $copy_offset;
 141
 142     $ctx->{have_holdings_to_show} = 0;
 143     $ctx->{have_mfhd_to_show} = 0;
 144
 145     $self->get_hold_copy_summary($rec_id, $org);
 146
 147     $self->timelog("past get_hold_copy_summary()");
 148     $self->ctx->{bib_is_dead} = OpenILS::Application::AppUtils->is_true(
 149         OpenILS::Utils::CStoreEditor->new->json_query({
 150             select => { bre => [ 'deleted' ] },
 151             from => 'bre',
 152             where => { 'id' => $rec_id }
 153         })->[0]->{deleted}
 154     );
 155
 156     $cstore->kill_me;
 157
 158     # Shortcut and help the machines with a 410 Gone status code
 159     if ($self->ctx->{bib_is_dead}) {
 160         return Apache2::Const::HTTP_GONE;
 161     }
 162
 163     # Shortcut and help the machines with a 404 Not Found status code
 164     if (!$ctx->{bre_id}) {
 165         return Apache2::Const::HTTP_NOT_FOUND;
 166     }
 167
 168     $ctx->{mfhd_summaries} =
 169         $self->get_mfhd_summaries($rec_id, $org, $copy_depth);
 170
 171     if (
 172         $ctx->{get_org_setting}->
 173             ($org, "opac.fully_compressed_serial_holdings")
 174     ) {
 175         # We're loading this data here? Are we therefore assuming that we
 176         # *are* going to display something in the "issues" expandy?
 177         $self->load_serial_holding_summaries($rec_id, $org, $copy_depth);
 178     } else {
 179         if ($ctx->{mfhd_summaries} && scalar(@{$ctx->{mfhd_summaries}})
 180         ) {
 181             $ctx->{have_mfhd_to_show} = 1;
 182         };
 183     }
 184
 185     $self->timelog("past serials holding stuff");
 186
 187     my %expandies = (
 188         marchtml => sub {
 189             $ctx->{marchtml} = $self->mk_marc_html($rec_id);
 190         },
 191         issues => sub {
 192             return;
 193             # XXX this needed?
 194         },
 195         cnbrowse => sub {
 196             $self->prepare_browse_call_numbers();
 197         }
 198     );
 199
 200     my @expand = $self->cgi->param('expand');
 201     if (grep {$_ eq 'all'} @expand) {
 202         $ctx->{expand_all} = 1;
 203         $expandies{$_}->() for keys %expandies;
 204
 205     } else {
 206         for my $exp (@expand) {
 207             $ctx->{"expand_$exp"} = 1;
 208             $expandies{$exp}->() if exists $expandies{$exp};
 209         }
 210     }
 211
 212     $self->timelog("past expandies");
 213
 214     $self->added_content_stage2($rec_id);
 215
 216     $self->timelog("past added content stage 2");
 217
 218     return Apache2::Const::OK;
 219 }
 220
 221 # collect IDs and info on the search that lead to this details page
 222 # If no search query, etc is present, we leave ctx.search_result_index == -1
 223 sub fetch_related_search_info {
 224     my $self = shift;
 225     my $rec_id = shift;
 226     my $ctx = $self->ctx;
 227     $ctx->{search_result_index} = -1;
 228
 229     $self->load_rresults(internal => 1);
 230
 231     my @search_ids = @{$ctx->{ids}};
 232     return unless @search_ids;
 233
 234     for my $idx (0..$#search_ids) {
 235         if ($search_ids[$idx] == $rec_id) {
 236             $ctx->{prev_search_record} = $search_ids[$idx - 1] if $idx > 0;
 237             $ctx->{next_search_record} = $search_ids[$idx + 1];
 238             $ctx->{search_result_index} = $idx;
 239             last;
 240         }
 241     }
 242
 243     $ctx->{first_search_record} = $search_ids[0];
 244     $ctx->{last_search_record} = $search_ids[-1];
 245 }
 246
 247
 248 sub mk_copy_query {
 249     my $self = shift;
 250     my $rec_id = shift;
 251     my $org = shift;
 252     my $depth = shift;
 253     my $copy_limit = shift;
 254     my $copy_offset = shift;
 255     my $pref_ou = shift;
 256
 257     my $query = $U->basic_opac_copy_query(
 258         $rec_id, undef, undef, $copy_limit, $copy_offset, $self->ctx->{is_staff}
 259     );
 260
 261     if($org != $self->ctx->{aou_tree}->()->id) {
 262         # no need to add the org join filter if we're not actually filtering
 263         $query->{from}->{acp}->{aou} = {
 264             fkey => 'circ_lib',
 265             field => 'id',
 266             filter => {
 267                 id => {
 268                     in => {
 269                         select => {aou => [{
 270                             column => 'id',
 271                             transform => 'actor.org_unit_descendants',
 272                             result_field => 'id',
 273                             params => [$depth]
 274                         }]},
 275                         from => 'aou',
 276                         where => {id => $org}
 277                     }
 278                 }
 279             }
 280         };
 281     };
 282
 283     # Unsure if we want these in the shared function, leaving here for now
 284     unshift(@{$query->{order_by}},
 285         { class => "aou", field => 'id',
 286           transform => 'evergreen.rank_ou', params => [$org, $pref_ou]
 287         }
 288     );
 289     push(@{$query->{order_by}},
 290         { class => "acp", field => 'id',
 291           transform => 'evergreen.rank_cp'
 292         }
 293     );
 294
 295     return $query;
 296 }
 297
 298 sub mk_marc_html {
 299     my($self, $rec_id) = @_;
 300
 301     # could be optimized considerably by performing the xslt on the already fetched record
 302     return $U->simplereq(
 303         'open-ils.search',
 304         'open-ils.search.biblio.record.html', $rec_id, 1);
 305 }
 306
 307 sub load_serial_holding_summaries {
 308     my ($self, $rec_id, $org, $depth) = @_;
 309
 310     my $limit = $self->cgi->param("slimit") || 10;
 311     my $offset = $self->cgi->param("soffset") || 0;
 312
 313     my $serial = create OpenSRF::AppSession("open-ils.serial");
 314
 315     # First, get the tree of /summaries/ of holdings.
 316     my $tree = $serial->request(
 317         "open-ils.serial.holding_summary_tree.by_bib",
 318         $rec_id, $org, $depth, $limit, $offset
 319     )->gather(1);
 320
 321     return if $self->apache_log_if_event(
 322         $tree, "getting holding summary tree for record $rec_id"
 323     );
 324
 325     # Next, if requested, get a list of individual holdings under a
 326     # particular summary.
 327     my $holdings;
 328     my $summary_id = int($self->cgi->param("sid") || 0);
 329     my $summary_type = $self->cgi->param("stype");
 330
 331     if ($summary_id and $summary_type) {
 332         my $expand_path = [ $self->cgi->param("sepath") ],
 333         my $expand_limit = $self->cgi->param("selimit");
 334         my $expand_offsets = [ $self->cgi->param("seoffset") ];
 335         my $auto_expand_first = 0;
 336
 337         if (not @$expand_offsets) {
 338             $expand_offsets = undef;
 339             $auto_expand_first = 1;
 340         }
 341
 342         $holdings = $serial->request(
 343             "open-ils.serial.holdings.grouped_by_summary",
 344             $summary_type, $summary_id,
 345             $expand_path, $expand_limit, $expand_offsets,
 346             $auto_expand_first,
 347             1 + ($self->ctx->{is_staff} ? 1 : 0)
 348         )->gather(1);
 349
 350         if ($holdings and ref $holdings eq "ARRAY") {
 351             $self->place_holdings_with_summary(
 352                     $tree, $holdings, $summary_id, $summary_type
 353             ) or $self->apache->log->warn(
 354                 "could not place holdings within summary tree"
 355             );
 356         } else {
 357             $self->apache_log_if_event(
 358                 $holdings, "getting holdings grouped by summary $summary_id"
 359             );
 360         }
 361     }
 362
 363     $serial->kill_me;
 364
 365     # The presence of any keys in the tree hash other than 'more' means that we
 366     # must have /something/ we could show.
 367     $self->ctx->{have_holdings_to_show} = grep { $_ ne 'more' } (keys %$tree);
 368
 369     $self->ctx->{holding_summary_tree} = $tree;
 370 }
 371
 372 # This helper to load_serial_holding_summaries() recursively searches in
 373 # $tree for a holding summary matching $sid and $stype, and places $holdings
 374 # within the node for that summary. IOW, this is about showing expanded
 375 # holdings under their "parent" summary.
 376 sub place_holdings_with_summary {
 377     my ($self, $tree, $holdings, $sid, $stype) = @_;
 378
 379     foreach my $sum (@{$tree->{holding_summaries}}) {
 380         if ($sum->{id} == $sid and $sum->{summary_type} eq $stype) {
 381             $sum->{holdings} = $holdings;
 382             return 1;
 383         }
 384     }
 385
 386     foreach my $child (@{$tree->{children}}) {
 387         return 1 if $self->place_holdings_with_summary(
 388             $child, $holdings, $sid, $stype
 389         );
 390     }
 391
 392     return;
 393 }
 394
 395 sub get_mfhd_summaries {
 396     my ($self, $rec_id, $org, $depth) = @_;
 397
 398     my $serial = create OpenSRF::AppSession("open-ils.search");
 399     my $result = $serial->request(
 400         "open-ils.search.serial.record.bib.retrieve",
 401         $rec_id, $org, $depth
 402     )->gather(1);
 403
 404     $serial->kill_me;
 405     return $result;
 406 }
 407
 408 sub any_call_number_label {
 409     my ($self) = @_;
 410
 411     if ($self->ctx->{copies} and @{$self->ctx->{copies}}) {
 412         return $self->ctx->{copies}->[0]->{call_number_label};
 413     } else {
 414         return;
 415     }
 416 }
 417
 418 sub prepare_browse_call_numbers {
 419     my ($self) = @_;
 420
 421     my $cn = ($self->cgi->param("cn") || $self->any_call_number_label) or
 422         return [];
 423
 424     my $org_unit = $self->ctx->{get_aou}->($self->_get_search_lib()) ||
 425         $self->ctx->{aou_tree}->();
 426
 427     my $supercat = create OpenSRF::AppSession("open-ils.supercat");
 428     my $results = $supercat->request(
 429         "open-ils.supercat.call_number.browse",
 430         $cn, $org_unit->shortname, 9, $self->cgi->param("cnoffset")
 431     )->gather(1) || [];
 432
 433     $supercat->kill_me;
 434
 435     $self->ctx->{browsed_call_numbers} = [
 436         map {
 437             $_->record->marc(
 438                 (new XML::LibXML)->parse_string($_->record->marc)
 439             );
 440             $_;
 441         } @$results
 442     ];
 443     $self->ctx->{browsing_ou} = $org_unit;
 444 }
 445
 446 sub get_hold_copy_summary {
 447     my ($self, $rec_id, $org) = @_;
 448     my $ctx = $self->ctx;
 449
 450     my $search = OpenSRF::AppSession->create('open-ils.search');
 451     my $copy_count_meth = 'open-ils.search.biblio.record.copy_count';
 452     # We want to include OPAC-invisible copies in a staff context
 453     if ($ctx->{is_staff}) {
 454         $copy_count_meth .= '.staff';
 455     }
 456     my $req1 = $search->request($copy_count_meth, $org, $rec_id);
 457
 458     # if org unit hiding applies, limit the hold count to holds
 459     # whose pickup library is within our depth-scoped tree
 460     my $count_args = {};
 461     while ($org and $ctx->{org_within_hiding_scope}->($org)) {
 462         $count_args->{pickup_lib_descendant} = $org;
 463         $org = $ctx->{get_aou}->($org)->parent_ou;
 464     }
 465
 466     $self->ctx->{record_hold_count} = $U->simplereq(
 467         'open-ils.circ', 'open-ils.circ.bre.holds.count',
 468         $rec_id, $count_args);
 469
 470     $self->ctx->{copy_summary} = $req1->recv->content;
 471
 472     $search->kill_me;
 473 }
 474
 475 sub load_print_record {
 476     my $self = shift;
 477
 478     my $rec_id = $self->ctx->{page_args}->[0]
 479         or return Apache2::Const::HTTP_BAD_REQUEST;
 480
 481     $self->{ctx}->{bre_id} = $rec_id;
 482     $self->{ctx}->{printable_record} = $U->simplereq(
 483         'open-ils.search',
 484         'open-ils.search.biblio.record.print', $rec_id);
 485
 486     return Apache2::Const::OK;
 487 }
 488
 489 sub load_email_record {
 490     my $self = shift;
 491
 492     my $rec_id = $self->ctx->{page_args}->[0]
 493         or return Apache2::Const::HTTP_BAD_REQUEST;
 494
 495     $self->{ctx}->{bre_id} = $rec_id;
 496     $U->simplereq(
 497         'open-ils.search',
 498         'open-ils.search.biblio.record.email',
 499         $self->ctx->{authtoken}, $rec_id);
 500
 501     return Apache2::Const::OK;
 502 }
 503
 504 # for each type, fire off the reqeust to see if content is available
 505 # ctx.added_content.$type.status:
 506 #   1 == available
 507 #   2 == not available
 508 #   3 == unknown
 509 sub added_content_stage1 {
 510     my $self = shift;
 511     my $rec_id = shift;
 512     my $ctx = $self->ctx;
 513     my $sel_type = $self->cgi->param('ac') || '';
 514
 515     # Connect to this machine's IP address, using the same
 516     # Host with which our caller used to connect to us.
 517     # This avoids us having to route out of the cluster
 518     # and back in to reach the top-level virtualhost.
 519     my $ac_addr = $ENV{SERVER_ADDR};
 520     my $ac_host = $self->apache->hostname;
 521     my $ac_failed = 0;
 522
 523     $logger->info("tpac: added content connecting to $ac_addr / $ac_host");
 524
 525     $ctx->{added_content} = {};
 526     for my $type (@$ac_types) {
 527         last if $ac_failed;
 528         $ctx->{added_content}->{$type} = {content => ''};
 529         $ctx->{added_content}->{$type}->{status} = 3;
 530
 531         $logger->debug("tpac: starting added content request for $rec_id => $type");
 532
 533         # Net::HTTP::NB is non-blocking /after/ the initial connect()
 534         # Passing Timeout=>1 ensures we wait no longer than 1 second to
 535         # connect to the local Evergreen instance (i.e. ourself).
 536         # Connecting to oneself should either be very fast (normal)
 537         # or very slow (routing problems).
 538
 539         my $req = Net::HTTP::NB->new(Host => $ac_addr, Timeout => 1);
 540         if (!$req) {
 541             $logger->warn("Unable to connect to $ac_addr / $ac_host".
 542                 " for added content lookup for $rec_id: $@");
 543             $ac_failed = 1;
 544             next;
 545         }
 546
 547         $req->host($self->apache->hostname);
 548
 549         my $http_type = ($type eq $sel_type) ? 'GET' : 'HEAD';
 550         $req->write_request($http_type => "/opac/extras/ac/$type/html/r/" . $rec_id);
 551         $ctx->{added_content}->{$type}->{request} = $req;
 552     }
 553 }
 554
 555 # check each outstanding request.  If it's ready, read the HTTP
 556 # status and use it to determine if content is available.  Otherwise,
 557 # leave the status as unknown.
 558 sub added_content_stage2 {
 559     my $self = shift;
 560     my $ctx = $self->ctx;
 561     my $sel_type = $self->cgi->param('ac') || '';
 562
 563     for my $type (keys %{$ctx->{added_content}}) {
 564         my $content = $ctx->{added_content}->{$type};
 565
 566         if ($content->{status} == 3) {
 567             $logger->debug("tpac: finishing added content request for $type");
 568
 569             my $req = $content->{request};
 570             my $sel = IO::Select->new($req);
 571
 572             # if we are requesting a specific type of content, give the
 573             # backend code a little extra time to retrieve the content.
 574             my $wait = $type eq $sel_type ? 3 : 0; # TODO: config?
 575
 576             if ($sel->can_read($wait)) {
 577                 my ($code) = $req->read_response_headers;
 578                 $content->{status} = $code eq '200' ? 1 : 2;
 579                 $logger->debug("tpac: added content request for $type returned $code");
 580
 581                 if ($code eq '200' and $type eq $sel_type) {
 582                     while (1) {
 583                         my $buf;
 584                         my $n = $req->read_entity_body($buf, 1024);
 585                         last unless $n;
 586                         $content->{content} .= $buf;
 587                     }
 588                 }
 589             }
 590         }
 591         # To avoid a lot of hanging connections.
 592         if ($content->{request}) {
 593             $content->{request}->shutdown(2);
 594             $content->{request}->close();
 595         }
 596     }
 597 }
 598
 599 1;