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