1 package OpenILS::Application::Search::Biblio;
2 use base qw/OpenILS::Application/;
3 use strict; use warnings;
6 use OpenSRF::Utils::JSON;
7 use OpenILS::Utils::Fieldmapper;
8 use OpenILS::Utils::ModsParser;
9 use OpenSRF::Utils::SettingsClient;
10 use OpenILS::Utils::CStoreEditor q/:funcs/;
11 use OpenSRF::Utils::Cache;
16 use OpenSRF::Utils::Logger qw/:logger/;
18 use Time::HiRes qw(time sleep);
19 use OpenSRF::EX qw(:try);
20 use Digest::MD5 qw(md5_hex);
26 $Data::Dumper::Indent = 0;
28 use OpenILS::Const qw/:const/;
30 use OpenILS::Application::AppUtils;
31 my $apputils = "OpenILS::Application::AppUtils";
34 my $pfx = "open-ils.search_";
42 $cache = OpenSRF::Utils::Cache->new('global');
43 my $sclient = OpenSRF::Utils::SettingsClient->new();
44 $cache_timeout = $sclient->config_value(
45 "apps", "open-ils.search", "app_settings", "cache_timeout" ) || 300;
47 $superpage_size = $sclient->config_value(
48 "apps", "open-ils.search", "app_settings", "superpage_size" ) || 500;
50 $max_superpages = $sclient->config_value(
51 "apps", "open-ils.search", "app_settings", "max_superpages" ) || 20;
53 $logger->info("Search cache timeout is $cache_timeout, ".
54 " superpage_size is $superpage_size, max_superpages is $max_superpages");
59 # ---------------------------------------------------------------------------
60 # takes a list of record id's and turns the docs into friendly
61 # mods structures. Creates one MODS structure for each doc id.
62 # ---------------------------------------------------------------------------
63 sub _records_to_mods {
69 my $session = OpenSRF::AppSession->create("open-ils.cstore");
70 my $request = $session->request(
71 "open-ils.cstore.direct.biblio.record_entry.search", { id => \@ids } );
73 while( my $resp = $request->recv ) {
74 my $content = $resp->content;
75 next if $content->id == OILS_PRECAT_RECORD;
76 my $u = OpenILS::Utils::ModsParser->new(); # FIXME: we really need a new parser for each object?
77 $u->start_mods_batch( $content->marc );
78 my $mods = $u->finish_mods_batch();
79 $mods->doc_id($content->id());
80 $mods->tcn($content->tcn_value);
84 $session->disconnect();
88 __PACKAGE__->register_method(
89 method => "record_id_to_mods",
90 api_name => "open-ils.search.biblio.record.mods.retrieve",
93 desc => "Provide ID, we provide the MODS object with copy count. "
94 . "Note: this method does NOT take an array of IDs like mods_slim.retrieve", # FIXME: do it here too
96 { desc => 'Record ID', type => 'number' }
99 desc => 'MODS object', type => 'object'
104 # converts a record into a mods object with copy counts attached
105 sub record_id_to_mods {
107 my( $self, $client, $org_id, $id ) = @_;
109 my $mods_list = _records_to_mods( $id );
110 my $mods_obj = $mods_list->[0];
111 my $cmethod = $self->method_lookup("open-ils.search.biblio.record.copy_count");
112 my ($count) = $cmethod->run($org_id, $id);
113 $mods_obj->copy_count($count);
120 __PACKAGE__->register_method(
121 method => "record_id_to_mods_slim",
122 api_name => "open-ils.search.biblio.record.mods_slim.retrieve",
126 desc => "Provide ID(s), we provide the MODS",
128 { desc => 'Record ID or array of IDs' }
131 desc => 'MODS object(s), event on error'
136 # converts a record into a mods object with NO copy counts attached
137 sub record_id_to_mods_slim {
138 my( $self, $client, $id ) = @_;
139 return undef unless defined $id;
141 if(ref($id) and ref($id) == 'ARRAY') {
142 return _records_to_mods( @$id );
144 my $mods_list = _records_to_mods( $id );
145 my $mods_obj = $mods_list->[0];
146 return OpenILS::Event->new('BIBLIO_RECORD_ENTRY_NOT_FOUND') unless $mods_obj;
152 __PACKAGE__->register_method(
153 method => "record_id_to_mods_slim_batch",
154 api_name => "open-ils.search.biblio.record.mods_slim.batch.retrieve",
157 sub record_id_to_mods_slim_batch {
158 my($self, $conn, $id_list) = @_;
159 $conn->respond(_records_to_mods($_)->[0]) for @$id_list;
164 # Returns the number of copies attached to a record based on org location
165 __PACKAGE__->register_method(
166 method => "record_id_to_copy_count",
167 api_name => "open-ils.search.biblio.record.copy_count",
169 desc => q/Returns a copy summary for the given record for the context org
170 unit and all ancestor org units/,
172 {desc => 'Context org unit id', type => 'number'},
173 {desc => 'Record ID', type => 'number'}
176 desc => q/summary object per org unit in the set, where the set
177 includes the context org unit and all parent org units.
178 Object includes the keys "transcendant", "count", "org_unit", "depth",
179 "unshadow", "available". Each is a count, except "org_unit" which is
180 the context org unit and "depth" which is the depth of the context org unit
187 __PACKAGE__->register_method(
188 method => "record_id_to_copy_count",
189 api_name => "open-ils.search.biblio.record.copy_count.staff",
192 desc => q/Returns a copy summary for the given record for the context org
193 unit and all ancestor org units/,
195 {desc => 'Context org unit id', type => 'number'},
196 {desc => 'Record ID', type => 'number'}
199 desc => q/summary object per org unit in the set, where the set
200 includes the context org unit and all parent org units.
201 Object includes the keys "transcendant", "count", "org_unit", "depth",
202 "unshadow", "available". Each is a count, except "org_unit" which is
203 the context org unit and "depth" which is the depth of the context org unit
210 __PACKAGE__->register_method(
211 method => "record_id_to_copy_count",
212 api_name => "open-ils.search.biblio.metarecord.copy_count",
214 desc => q/Returns a copy summary for the given record for the context org
215 unit and all ancestor org units/,
217 {desc => 'Context org unit id', type => 'number'},
218 {desc => 'Record ID', type => 'number'}
221 desc => q/summary object per org unit in the set, where the set
222 includes the context org unit and all parent org units.
223 Object includes the keys "transcendant", "count", "org_unit", "depth",
224 "unshadow", "available". Each is a count, except "org_unit" which is
225 the context org unit and "depth" which is the depth of the context org unit
232 __PACKAGE__->register_method(
233 method => "record_id_to_copy_count",
234 api_name => "open-ils.search.biblio.metarecord.copy_count.staff",
236 desc => q/Returns a copy summary for the given record for the context org
237 unit and all ancestor org units/,
239 {desc => 'Context org unit id', type => 'number'},
240 {desc => 'Record ID', type => 'number'}
243 desc => q/summary object per org unit in the set, where the set
244 includes the context org unit and all parent org units.
245 Object includes the keys "transcendant", "count", "org_unit", "depth",
246 "unshadow", "available". Each is a count, except "org_unit" which is
247 the context org unit and "depth" which is the depth of the context org
248 unit. "depth" is always -1 when the count from a lasso search is
249 performed, since depth doesn't mean anything in a lasso context.
256 sub record_id_to_copy_count {
257 my( $self, $client, $org_id, $record_id ) = @_;
259 return [] unless $record_id;
261 my $key = $self->api_name =~ /metarecord/ ? 'metarecord' : 'record';
262 my $staff = $self->api_name =~ /staff/ ? 't' : 'f';
264 my $data = $U->cstorereq(
265 "open-ils.cstore.json_query.atomic",
266 { from => ['asset.' . $key . '_copy_count' => $org_id => $record_id => $staff] }
270 for my $d ( @$data ) { # fix up the key name change required by stored-proc version
271 $$d{count} = delete $$d{visible};
275 return [ sort { $a->{depth} <=> $b->{depth} } @count ];
278 __PACKAGE__->register_method(
279 method => "record_has_holdable_copy",
280 api_name => "open-ils.search.biblio.record.has_holdable_copy",
282 desc => q/Returns a boolean indicating if a record has any holdable copies./,
284 {desc => 'Record ID', type => 'number'}
287 desc => q/bool indicating if the record has any holdable copies/,
293 __PACKAGE__->register_method(
294 method => "record_has_holdable_copy",
295 api_name => "open-ils.search.biblio.metarecord.has_holdable_copy",
297 desc => q/Returns a boolean indicating if a record has any holdable copies./,
299 {desc => 'Record ID', type => 'number'}
302 desc => q/bool indicating if the record has any holdable copies/,
308 sub record_has_holdable_copy {
309 my($self, $client, $record_id ) = @_;
311 return 0 unless $record_id;
313 my $key = $self->api_name =~ /metarecord/ ? 'metarecord' : 'record';
315 my $data = $U->cstorereq(
316 "open-ils.cstore.json_query.atomic",
317 { from => ['asset.' . $key . '_has_holdable_copy' => $record_id ] }
320 return ${@$data[0]}{'asset.' . $key . '_has_holdable_copy'} eq 't';
324 __PACKAGE__->register_method(
325 method => "biblio_search_tcn",
326 api_name => "open-ils.search.biblio.tcn",
329 desc => "Retrieve related record ID(s) given a TCN",
331 { desc => 'TCN', type => 'string' },
332 { desc => 'Flag indicating to include deleted records', type => 'string' }
335 desc => 'Results object like: { "count": $i, "ids": [...] }',
342 sub biblio_search_tcn {
344 my( $self, $client, $tcn, $include_deleted ) = @_;
346 $tcn =~ s/^\s+|\s+$//og;
348 my $e = new_editor();
349 my $search = {tcn_value => $tcn};
350 $search->{deleted} = 'f' unless $include_deleted;
351 my $recs = $e->search_biblio_record_entry( $search, {idlist =>1} );
353 return { count => scalar(@$recs), ids => $recs };
357 # --------------------------------------------------------------------------------
359 __PACKAGE__->register_method(
360 method => "biblio_barcode_to_copy",
361 api_name => "open-ils.search.asset.copy.find_by_barcode",
363 sub biblio_barcode_to_copy {
364 my( $self, $client, $barcode ) = @_;
365 my( $copy, $evt ) = $U->fetch_copy_by_barcode($barcode);
370 __PACKAGE__->register_method(
371 method => "biblio_id_to_copy",
372 api_name => "open-ils.search.asset.copy.batch.retrieve",
374 sub biblio_id_to_copy {
375 my( $self, $client, $ids ) = @_;
376 $logger->info("Fetching copies @$ids");
377 return $U->cstorereq(
378 "open-ils.cstore.direct.asset.copy.search.atomic", { id => $ids } );
382 __PACKAGE__->register_method(
383 method => "biblio_id_to_uris",
384 api_name=> "open-ils.search.asset.uri.retrieve_by_bib",
388 @param BibID Which bib record contains the URIs
389 @param OrgID Where to look for URIs
390 @param OrgDepth Range adjustment for OrgID
391 @return A stream or list of 'auri' objects
395 sub biblio_id_to_uris {
396 my( $self, $client, $bib, $org, $depth ) = @_;
397 die "Org ID required" unless defined($org);
398 die "Bib ID required" unless defined($bib);
401 push @params, $depth if (defined $depth);
403 my $ids = $U->cstorereq( "open-ils.cstore.json_query.atomic",
404 { select => { auri => [ 'id' ] },
408 field => 'call_number',
414 filter => { active => 't' }
425 select => { aou => [ { column => 'id', transform => 'actor.org_unit_descendants', params => \@params, result_field => 'id' } ] },
427 where => { id => $org },
437 my $uris = $U->cstorereq(
438 "open-ils.cstore.direct.asset.uri.search.atomic",
439 { id => [ map { (values %$_) } @$ids ] }
442 $client->respond($_) for (@$uris);
448 __PACKAGE__->register_method(
449 method => "copy_retrieve",
450 api_name => "open-ils.search.asset.copy.retrieve",
453 desc => 'Retrieve a copy object based on the Copy ID',
455 { desc => 'Copy ID', type => 'number'}
458 desc => 'Copy object, event on error'
464 my( $self, $client, $cid ) = @_;
465 my( $copy, $evt ) = $U->fetch_copy($cid);
466 return $evt || $copy;
469 __PACKAGE__->register_method(
470 method => "volume_retrieve",
471 api_name => "open-ils.search.asset.call_number.retrieve"
473 sub volume_retrieve {
474 my( $self, $client, $vid ) = @_;
475 my $e = new_editor();
476 my $vol = $e->retrieve_asset_call_number($vid) or return $e->event;
480 __PACKAGE__->register_method(
481 method => "fleshed_copy_retrieve_batch",
482 api_name => "open-ils.search.asset.copy.fleshed.batch.retrieve",
486 sub fleshed_copy_retrieve_batch {
487 my( $self, $client, $ids ) = @_;
488 $logger->info("Fetching fleshed copies @$ids");
489 return $U->cstorereq(
490 "open-ils.cstore.direct.asset.copy.search.atomic",
493 flesh_fields => { acp => [ qw/ circ_lib location status stat_cat_entries parts / ] }
498 __PACKAGE__->register_method(
499 method => "fleshed_copy_retrieve",
500 api_name => "open-ils.search.asset.copy.fleshed.retrieve",
503 sub fleshed_copy_retrieve {
504 my( $self, $client, $id ) = @_;
505 my( $c, $e) = $U->fetch_fleshed_copy($id);
510 __PACKAGE__->register_method(
511 method => 'fleshed_by_barcode',
512 api_name => "open-ils.search.asset.copy.fleshed2.find_by_barcode",
515 sub fleshed_by_barcode {
516 my( $self, $conn, $barcode ) = @_;
517 my $e = new_editor();
518 my $copyid = $e->search_asset_copy(
519 {barcode => $barcode, deleted => 'f'}, {idlist=>1})->[0]
521 return fleshed_copy_retrieve2( $self, $conn, $copyid);
525 __PACKAGE__->register_method(
526 method => "fleshed_copy_retrieve2",
527 api_name => "open-ils.search.asset.copy.fleshed2.retrieve",
531 sub fleshed_copy_retrieve2 {
532 my( $self, $client, $id ) = @_;
533 my $e = new_editor();
534 my $copy = $e->retrieve_asset_copy(
541 qw/ location status stat_cat_entry_copy_maps notes age_protect parts peer_record_maps /
543 ascecm => [qw/ stat_cat stat_cat_entry /],
547 ) or return $e->event;
549 # For backwards compatibility
550 #$copy->stat_cat_entries($copy->stat_cat_entry_copy_maps);
552 if( $copy->status->id == OILS_COPY_STATUS_CHECKED_OUT ) {
554 $e->search_action_circulation(
556 { target_copy => $copy->id },
558 order_by => { circ => 'xact_start desc' },
570 __PACKAGE__->register_method(
571 method => 'flesh_copy_custom',
572 api_name => 'open-ils.search.asset.copy.fleshed.custom',
576 sub flesh_copy_custom {
577 my( $self, $conn, $copyid, $fields ) = @_;
578 my $e = new_editor();
579 my $copy = $e->retrieve_asset_copy(
589 ) or return $e->event;
594 __PACKAGE__->register_method(
595 method => "biblio_barcode_to_title",
596 api_name => "open-ils.search.biblio.find_by_barcode",
599 sub biblio_barcode_to_title {
600 my( $self, $client, $barcode ) = @_;
602 my $title = $apputils->simple_scalar_request(
604 "open-ils.storage.biblio.record_entry.retrieve_by_barcode", $barcode );
606 return { ids => [ $title->id ], count => 1 } if $title;
607 return { count => 0 };
610 __PACKAGE__->register_method(
611 method => 'title_id_by_item_barcode',
612 api_name => 'open-ils.search.bib_id.by_barcode',
615 desc => 'Retrieve bib record id associated with the copy identified by the given barcode',
617 { desc => 'Item barcode', type => 'string' }
620 desc => 'Bib record id.'
625 __PACKAGE__->register_method(
626 method => 'title_id_by_item_barcode',
627 api_name => 'open-ils.search.multi_home.bib_ids.by_barcode',
630 desc => 'Retrieve bib record ids associated with the copy identified by the given barcode. This includes peer bibs for Multi-Home items.',
632 { desc => 'Item barcode', type => 'string' }
635 desc => 'Array of bib record ids. First element is the native bib for the item.'
641 sub title_id_by_item_barcode {
642 my( $self, $conn, $barcode ) = @_;
643 my $e = new_editor();
644 my $copies = $e->search_asset_copy(
646 { deleted => 'f', barcode => $barcode },
650 acp => [ 'call_number' ],
657 return $e->event unless @$copies;
659 if( $self->api_name =~ /multi_home/ ) {
660 my $multi_home_list = $e->search_biblio_peer_bib_copy_map(
662 { target_copy => $$copies[0]->id }
665 my @temp = map { $_->peer_record } @{ $multi_home_list };
666 unshift @temp, $$copies[0]->call_number->record->id;
669 return $$copies[0]->call_number->record->id;
673 __PACKAGE__->register_method(
674 method => 'find_peer_bibs',
675 api_name => 'open-ils.search.peer_bibs.test',
678 desc => 'Tests to see if the specified record is a peer record.',
680 { desc => 'Biblio record entry Id', type => 'number' }
683 desc => 'True if specified id can be found in biblio.peer_bib_copy_map.peer_record.',
689 __PACKAGE__->register_method(
690 method => 'find_peer_bibs',
691 api_name => 'open-ils.search.peer_bibs',
694 desc => 'Return acps and mvrs for multi-home items linked to specified peer record.',
696 { desc => 'Biblio record entry Id', type => 'number' }
699 desc => '{ records => Array of mvrs, items => array of acps }',
706 my( $self, $client, $doc_id ) = @_;
707 my $e = new_editor();
709 my $multi_home_list = $e->search_biblio_peer_bib_copy_map(
711 { peer_record => $doc_id },
715 bpbcm => [ 'target_copy', 'peer_type' ],
716 acp => [ 'call_number', 'location', 'status', 'peer_record_maps' ]
722 if ($self->api_name =~ /test/) {
723 return scalar( @{$multi_home_list} ) > 0 ? 1 : 0;
726 if (scalar(@{$multi_home_list})==0) {
730 # create a unique hash of the primary record MVRs for foreign copies
731 # XXX PLEASE let's change to unAPI2 (supports foreign copies) in the TT opac?!?
733 ($_->target_copy->call_number->record, _records_to_mods( $_->target_copy->call_number->record )->[0])
736 # set the foreign_copy_maps field to an empty array
737 map { $rec_hash{$_}->foreign_copy_maps([]) } keys( %rec_hash );
739 # push the maps onto the correct MVRs
740 for (@$multi_home_list) {
742 @{$rec_hash{ $_->target_copy->call_number->record }->foreign_copy_maps()},
747 return [sort {$a->title cmp $b->title} values(%rec_hash)];
750 __PACKAGE__->register_method(
751 method => "biblio_copy_to_mods",
752 api_name => "open-ils.search.biblio.copy.mods.retrieve",
755 # takes a copy object and returns it fleshed mods object
756 sub biblio_copy_to_mods {
757 my( $self, $client, $copy ) = @_;
759 my $volume = $U->cstorereq(
760 "open-ils.cstore.direct.asset.call_number.retrieve",
761 $copy->call_number() );
763 my $mods = _records_to_mods($volume->record());
764 $mods = shift @$mods;
765 $volume->copies([$copy]);
766 push @{$mods->call_numbers()}, $volume;
774 OpenILS::Application::Search::Biblio
780 =head3 open-ils.search.biblio.multiclass.query (arghash, query, docache)
782 For arghash and docache, see B<open-ils.search.biblio.multiclass>.
784 The query argument is a string, but built like a hash with key: value pairs.
785 Recognized search keys include:
787 keyword (kw) - search keyword(s) *
788 author (au) - search author(s) *
789 name (au) - same as author *
790 title (ti) - search title *
791 subject (su) - search subject *
792 series (se) - search series *
793 lang - limit by language (specify multiple langs with lang:l1 lang:l2 ...)
794 site - search at specified org unit, corresponds to actor.org_unit.shortname
795 pref_ou - extend search to specified org unit, corresponds to actor.org_unit.shortname
796 sort - sort type (title, author, pubdate)
797 dir - sort direction (asc, desc)
798 available - if set to anything other than "false" or "0", limits to available items
800 * Searching keyword, author, title, subject, and series supports additional search
801 subclasses, specified with a "|". For example, C<title|proper:gone with the wind>.
803 For more, see B<config.metabib_field>.
807 foreach (qw/open-ils.search.biblio.multiclass.query
808 open-ils.search.biblio.multiclass.query.staff
809 open-ils.search.metabib.multiclass.query
810 open-ils.search.metabib.multiclass.query.staff/)
812 __PACKAGE__->register_method(
814 method => 'multiclass_query',
816 desc => 'Perform a search query. The .staff version of the call includes otherwise hidden hits.',
818 {name => 'arghash', desc => 'Arg hash (see open-ils.search.biblio.multiclass)', type => 'object'},
819 {name => 'query', desc => 'Raw human-readable query (see perldoc '. __PACKAGE__ .')', type => 'string'},
820 {name => 'docache', desc => 'Flag for caching (see open-ils.search.biblio.multiclass)', type => 'object'},
823 desc => 'Search results from query, like: { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }',
824 type => 'object', # TODO: update as miker's new elements are included
830 sub multiclass_query {
831 # arghash only really supports limit/offset anymore
832 my($self, $conn, $arghash, $query, $docache) = @_;
836 $query =~ s/^\s+//go;
837 $query =~ s/\s+/ /go;
838 $arghash->{query} = $query
841 $logger->debug("initial search query => $query") if $query;
843 (my $method = $self->api_name) =~ s/\.query/.staged/o;
844 return $self->method_lookup($method)->dispatch($arghash, $docache);
848 __PACKAGE__->register_method(
849 method => 'cat_search_z_style_wrapper',
850 api_name => 'open-ils.search.biblio.zstyle',
852 signature => q/@see open-ils.search.biblio.multiclass/
855 __PACKAGE__->register_method(
856 method => 'cat_search_z_style_wrapper',
857 api_name => 'open-ils.search.biblio.zstyle.staff',
859 signature => q/@see open-ils.search.biblio.multiclass/
862 sub cat_search_z_style_wrapper {
865 my $authtoken = shift;
868 my $cstore = OpenSRF::AppSession->connect('open-ils.cstore');
870 my $ou = $cstore->request(
871 'open-ils.cstore.direct.actor.org_unit.search',
872 { parent_ou => undef }
875 my $result = { service => 'native-evergreen-catalog', records => [] };
876 my $searchhash = { limit => $$args{limit}, offset => $$args{offset}, org_unit => $ou->id };
878 $$searchhash{searches}{title}{term} = $$args{search}{title} if $$args{search}{title};
879 $$searchhash{searches}{author}{term} = $$args{search}{author} if $$args{search}{author};
880 $$searchhash{searches}{subject}{term} = $$args{search}{subject} if $$args{search}{subject};
881 $$searchhash{searches}{keyword}{term} = $$args{search}{keyword} if $$args{search}{keyword};
882 $$searchhash{searches}{'identifier|isbn'}{term} = $$args{search}{isbn} if $$args{search}{isbn};
883 $$searchhash{searches}{'identifier|issn'}{term} = $$args{search}{issn} if $$args{search}{issn};
884 $$searchhash{searches}{'identifier|upc'}{term} = $$args{search}{upc} if $$args{search}{upc};
886 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{tcn} if $$args{search}{tcn};
887 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{publisher} if $$args{search}{publisher};
888 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{pubdate} if $$args{search}{pubdate};
889 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{item_type} if $$args{search}{item_type};
891 my $method = 'open-ils.search.biblio.multiclass.staged';
892 $method .= '.staff' if $self->api_name =~ /staff$/;
894 my ($list) = $self->method_lookup($method)->run( $searchhash );
896 if ($list->{count} > 0 and @{$list->{ids}}) {
897 $result->{count} = $list->{count};
899 my $records = $cstore->request(
900 'open-ils.cstore.direct.biblio.record_entry.search.atomic',
901 { id => [ map { ( $_->[0] ) } @{$list->{ids}} ] }
904 for my $rec ( @$records ) {
906 my $u = OpenILS::Utils::ModsParser->new();
907 $u->start_mods_batch( $rec->marc );
908 my $mods = $u->finish_mods_batch();
910 push @{ $result->{records} }, { mvr => $mods, marcxml => $rec->marc, bibid => $rec->id };
916 $cstore->disconnect();
920 # ----------------------------------------------------------------------------
921 # These are the main OPAC search methods
922 # ----------------------------------------------------------------------------
924 __PACKAGE__->register_method(
925 method => 'the_quest_for_knowledge',
926 api_name => 'open-ils.search.biblio.multiclass',
928 desc => "Performs a multi class biblio or metabib search",
931 desc => "A search hash with keys: "
932 . "searches, org_unit, depth, limit, offset, format, sort, sort_dir. "
933 . "See perldoc " . __PACKAGE__ . " for more detail",
937 desc => "A flag to enable/disable searching and saving results in cache (default OFF)",
942 desc => 'An object of the form: '
943 . '{ "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }',
948 =head3 open-ils.search.biblio.multiclass (search-hash, docache)
950 The search-hash argument can have the following elements:
952 searches: { "$class" : "$value", ...} [REQUIRED]
953 org_unit: The org id to focus the search at
954 depth : The org depth
955 limit : The search limit default: 10
956 offset : The search offset default: 0
957 format : The MARC format
958 sort : What field to sort the results on? [ author | title | pubdate ]
959 sort_dir: What direction do we sort? [ asc | desc ]
960 tag_circulated_records : Boolean, if true, records that are in the user's visible checkout history
961 will be tagged with an additional value ("1") as the last value in the record ID array for
962 each record. Requires the 'authtoken'
963 authtoken : Authentication token string; When actions are performed that require a user login
964 (e.g. tagging circulated records), the authentication token is required
966 The searches element is required, must have a hashref value, and the hashref must contain at least one
967 of the following classes as a key:
975 The value paired with a key is the associated search string.
977 The docache argument enables/disables searching and saving results in cache (default OFF).
979 The return object, if successful, will look like:
981 { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }
985 __PACKAGE__->register_method(
986 method => 'the_quest_for_knowledge',
987 api_name => 'open-ils.search.biblio.multiclass.staff',
988 signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items. Otherwise, @see open-ils.search.biblio.multiclass/
990 __PACKAGE__->register_method(
991 method => 'the_quest_for_knowledge',
992 api_name => 'open-ils.search.metabib.multiclass',
993 signature => q/@see open-ils.search.biblio.multiclass/
995 __PACKAGE__->register_method(
996 method => 'the_quest_for_knowledge',
997 api_name => 'open-ils.search.metabib.multiclass.staff',
998 signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items. Otherwise, @see open-ils.search.biblio.multiclass/
1001 sub the_quest_for_knowledge {
1002 my( $self, $conn, $searchhash, $docache ) = @_;
1004 return { count => 0 } unless $searchhash and
1005 ref $searchhash->{searches} eq 'HASH';
1007 my $method = 'open-ils.storage.biblio.multiclass.search_fts';
1011 if($self->api_name =~ /metabib/) {
1013 $method =~ s/biblio/metabib/o;
1016 # do some simple sanity checking
1017 if(!$searchhash->{searches} or
1018 ( !grep { /^(?:title|author|subject|series|keyword|identifier\|is[bs]n)/ } keys %{$searchhash->{searches}} ) ) {
1019 return { count => 0 };
1022 my $offset = $searchhash->{offset} || 0; # user value or default in local var now
1023 my $limit = $searchhash->{limit} || 10; # user value or default in local var now
1024 my $end = $offset + $limit - 1;
1026 my $maxlimit = 5000;
1027 $searchhash->{offset} = 0; # possible user value overwritten in hash
1028 $searchhash->{limit} = $maxlimit; # possible user value overwritten in hash
1030 return { count => 0 } if $offset > $maxlimit;
1033 push( @search, ($_ => $$searchhash{$_})) for (sort keys %$searchhash);
1034 my $s = OpenSRF::Utils::JSON->perl2JSON(\@search);
1035 my $ckey = $pfx . md5_hex($method . $s);
1037 $logger->info("bib search for: $s");
1039 $searchhash->{limit} -= $offset;
1043 my $result = ($docache) ? search_cache($ckey, $offset, $limit) : undef;
1047 $method .= ".staff" if($self->api_name =~ /staff/);
1048 $method .= ".atomic";
1050 for (keys %$searchhash) {
1051 delete $$searchhash{$_}
1052 unless defined $$searchhash{$_};
1055 $result = $U->storagereq( $method, %$searchhash );
1059 $docache = 0; # results came FROM cache, so we don't write back
1062 return {count => 0} unless ($result && $$result[0]);
1066 my $count = ($ismeta) ? $result->[0]->[3] : $result->[0]->[2];
1069 # If we didn't get this data from the cache, put it into the cache
1070 # then return the correct offset of records
1071 $logger->debug("putting search cache $ckey\n");
1072 put_cache($ckey, $count, \@recs);
1076 # if we have the full set of data, trim out
1077 # the requested chunk based on limit and offset
1079 for ($offset..$end) {
1080 last unless $recs[$_];
1081 push(@t, $recs[$_]);
1086 return { ids => \@recs, count => $count };
1090 __PACKAGE__->register_method(
1091 method => 'staged_search',
1092 api_name => 'open-ils.search.biblio.multiclass.staged',
1094 desc => 'Staged search filters out unavailable items. This means that it relies on an estimation strategy for determining ' .
1095 'how big a "raw" search result chunk (i.e. a "superpage") to obtain prior to filtering. See "estimation_strategy" in your SRF config.',
1098 desc => "A search hash with keys: "
1099 . "searches, limit, offset. The others are optional, but the 'searches' key/value pair is required, with the value being a hashref. "
1100 . "See perldoc " . __PACKAGE__ . " for more detail",
1104 desc => "A flag to enable/disable searching and saving results in cache, including facets (default OFF)",
1109 desc => 'Hash with keys: count, core_limit, superpage_size, superpage_summary, facet_key, ids. '
1110 . 'The superpage_summary value is a hashref that includes keys: estimated_hit_count, visible.',
1115 __PACKAGE__->register_method(
1116 method => 'staged_search',
1117 api_name => 'open-ils.search.biblio.multiclass.staged.staff',
1118 signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items. Otherwise, @see open-ils.search.biblio.multiclass.staged/
1120 __PACKAGE__->register_method(
1121 method => 'staged_search',
1122 api_name => 'open-ils.search.metabib.multiclass.staged',
1123 signature => q/@see open-ils.search.biblio.multiclass.staged/
1125 __PACKAGE__->register_method(
1126 method => 'staged_search',
1127 api_name => 'open-ils.search.metabib.multiclass.staged.staff',
1128 signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items. Otherwise, @see open-ils.search.biblio.multiclass.staged/
1131 my $estimation_strategy;
1133 my($self, $conn, $search_hash, $docache) = @_;
1135 my $IAmMetabib = ($self->api_name =~ /metabib/) ? 1 : 0;
1137 my $method = $IAmMetabib?
1138 'open-ils.storage.metabib.multiclass.staged.search_fts':
1139 'open-ils.storage.biblio.multiclass.staged.search_fts';
1141 $method .= '.staff' if $self->api_name =~ /staff$/;
1142 $method .= '.atomic';
1144 if (!$search_hash->{query}) {
1145 return {count => 0} unless (
1147 $search_hash->{searches} and
1148 scalar( keys %{$search_hash->{searches}} ));
1151 my $search_duration;
1152 my $user_offset = $search_hash->{offset} || 0; # user-specified offset
1153 my $user_limit = $search_hash->{limit} || 10;
1154 my $ignore_facet_classes = $search_hash->{ignore_facet_classes};
1155 $user_offset = ($user_offset >= 0) ? $user_offset : 0;
1156 $user_limit = ($user_limit >= 0) ? $user_limit : 10;
1159 # we're grabbing results on a per-superpage basis, which means the
1160 # limit and offset should coincide with superpage boundaries
1161 $search_hash->{offset} = 0;
1162 $search_hash->{limit} = $superpage_size;
1164 # force a well-known check_limit
1165 $search_hash->{check_limit} = $superpage_size;
1166 # restrict total tested to superpage size * number of superpages
1167 $search_hash->{core_limit} = $superpage_size * $max_superpages;
1169 # Set the configured estimation strategy, defaults to 'inclusion'.
1170 unless ($estimation_strategy) {
1171 $estimation_strategy = OpenSRF::Utils::SettingsClient
1174 apps => 'open-ils.search', app_settings => 'estimation_strategy'
1177 $search_hash->{estimation_strategy} = $estimation_strategy;
1179 # pull any existing results from the cache
1180 my $key = search_cache_key($method, $search_hash);
1181 my $facet_key = $key.'_facets';
1182 my $cache_data = $cache->get_cache($key) || {};
1184 # First, we want to make sure that someone else isn't currently trying to perform exactly
1185 # this same search. The point is to allow just one instance of a search to fill the needs
1186 # of all concurrent, identical searches. This will avoid spammy searches killing the
1187 # database without requiring admins to start locking some IP addresses out entirely.
1189 # There's still a tiny race condition where 2 might run, but without sigificantly more code
1190 # and complexity, this is close to the best we can do.
1192 if ($cache_data->{running}) { # someone is already doing the search...
1193 my $stop_looping = time() + $cache_timeout;
1194 while ( sleep(1) and time() < $stop_looping ) { # sleep for a second ... maybe they'll finish
1195 $cache_data = $cache->get_cache($key) || {};
1196 last if (!$cache_data->{running});
1198 } elsif (!$cache_data->{0}) { # we're the first ... let's give it a try
1199 $cache->put_cache($key, { running => $$ }, $cache_timeout / 3);
1202 # keep retrieving results until we find enough to
1203 # fulfill the user-specified limit and offset
1204 my $all_results = [];
1205 my $page; # current superpage
1206 my $current_page_summary = {};
1207 my $global_summary = {checked => 0, visible => 0, excluded => 0, deleted => 0, total => 0};
1210 for($page = 0; $page < $max_superpages; $page++) {
1212 my $data = $cache_data->{$page};
1216 $logger->debug("staged search: analyzing superpage $page");
1219 # this window of results is already cached
1220 $logger->debug("staged search: found cached results");
1221 $summary = $data->{summary};
1222 $results = $data->{results};
1225 # retrieve the window of results from the database
1226 $logger->debug("staged search: fetching results from the database");
1227 $search_hash->{skip_check} = $page * $superpage_size;
1228 $search_hash->{return_query} = $page == 0 ? 1 : 0;
1231 $results = $U->storagereq($method, %$search_hash);
1232 $search_duration = time - $start;
1233 $summary = shift(@$results) if $results;
1236 $logger->info("search timed out: duration=$search_duration: params=".
1237 OpenSRF::Utils::JSON->perl2JSON($search_hash));
1238 return {count => 0};
1241 $logger->info("staged search: DB call took $search_duration seconds and returned ".scalar(@$results)." rows, including summary");
1243 # Create backwards-compatible result structures
1245 $results = [map {[$_->{id}, $_->{badges}, $_->{popularity}, $_->{rel}, $_->{record}]} @$results];
1247 $results = [map {[$_->{id}, $_->{badges}, $_->{popularity}]} @$results];
1250 push @$new_ids, grep {defined($_)} map {$_->[0]} @$results;
1251 $results = [grep {defined $_->[0]} @$results];
1252 cache_staged_search_page($key, $page, $summary, $results) if $docache;
1255 tag_circulated_records($search_hash->{authtoken}, $results, $IAmMetabib)
1256 if $search_hash->{tag_circulated_records} and $search_hash->{authtoken};
1258 $current_page_summary = $summary;
1260 # add the new set of results to the set under construction
1261 push(@$all_results, @$results);
1263 my $current_count = scalar(@$all_results);
1265 if ($page == 0) { # all summaries are the same, just get the first
1266 for (keys %$summary) {
1267 $global_summary->{$_} = $summary->{$_};
1271 # we've found all the possible hits
1272 last if $current_count == $summary->{visible};
1274 # we've found enough results to satisfy the requested limit/offset
1275 last if $current_count >= ($user_limit + $user_offset);
1277 # we've scanned all possible hits
1278 last if($summary->{checked} < $superpage_size);
1281 # Let other backends grab our data now that we're done.
1282 $cache_data = $cache->get_cache($key);
1283 if ($$cache_data{running} and $$cache_data{running} == $$) {
1284 delete $$cache_data{running};
1285 $cache->put_cache($key, $cache_data, $cache_timeout);
1288 my @results = grep {defined $_} @$all_results[$user_offset..($user_offset + $user_limit - 1)];
1290 $conn->respond_complete(
1292 global_summary => $global_summary,
1293 count => $global_summary->{visible},
1294 core_limit => $search_hash->{core_limit},
1296 superpage_size => $search_hash->{check_limit},
1297 superpage_summary => $current_page_summary,
1298 facet_key => $facet_key,
1303 $logger->info("Completed canonicalized search is: $$global_summary{canonicalized_query}");
1305 return cache_facets($facet_key, $new_ids, $IAmMetabib, $ignore_facet_classes) if $docache;
1308 sub fetch_display_fields {
1311 my $highlight_map = shift;
1315 $conn->respond_complete;
1319 my $hl_map_string = "";
1320 if (ref($highlight_map) =~ /HASH/) {
1321 for my $tsq (keys %$highlight_map) {
1322 my $field_list = join(',', @{$$highlight_map{$tsq}});
1323 $hl_map_string .= ' || ' if $hl_map_string;
1324 $hl_map_string .= "hstore(($tsq)\:\:TEXT,'$field_list')";
1328 my $e = new_editor();
1330 for my $record ( @records ) {
1331 next unless ($record && $hl_map_string);
1334 {from => ['search.highlight_display_fields', $record, $hl_map_string]}
1341 __PACKAGE__->register_method(
1342 method => 'fetch_display_fields',
1343 api_name => 'open-ils.search.fetch.metabib.display_field.highlight',
1348 sub tag_circulated_records {
1349 my ($auth, $results, $metabib) = @_;
1350 my $e = new_editor(authtoken => $auth);
1351 return $results unless $e->checkauth;
1354 select => { acn => [{ column => 'record', alias => 'tagme' }] },
1355 from => { auch => { acp => { join => 'acn' }} },
1356 where => { usr => $e->requestor->id },
1362 select => { mmrsm => [{ column => 'metarecord', alias => 'tagme' }] },
1364 where => { source => { in => $query } },
1369 # Give me the distinct set of bib records that exist in the user's visible circulation history
1370 my $circ_recs = $e->json_query( $query );
1372 # if the record appears in the circ history, push a 1 onto
1373 # the rec array structure to indicate truthiness
1374 for my $rec (@$results) {
1375 push(@$rec, 1) if grep { $_->{tagme} eq $$rec[0] } @$circ_recs;
1381 # creates a unique token to represent the query in the cache
1382 sub search_cache_key {
1384 my $search_hash = shift;
1386 for my $key (sort keys %$search_hash) {
1387 push(@sorted, ($key => $$search_hash{$key}))
1388 unless $key eq 'limit' or
1390 $key eq 'skip_check';
1392 my $s = OpenSRF::Utils::JSON->perl2JSON(\@sorted);
1393 return $pfx . md5_hex($method . $s);
1396 sub retrieve_cached_facets {
1402 return undef unless ($key and $key =~ /_facets$/);
1405 local $SIG{ALRM} = sub {die};
1406 alarm(10); # we'll sleep for as much as 10s
1408 die if $cache->get_cache($key . '_COMPLETE');
1409 } while (sleep(0.05));
1414 my $blob = $cache->get_cache($key) || {};
1418 for my $f ( keys %$blob ) {
1419 my @sorted = map{ { $$_[1] => $$_[0] } } sort {$$b[0] <=> $$a[0] || $$a[1] cmp $$b[1]} map { [$$blob{$f}{$_}, $_] } keys %{ $$blob{$f} };
1420 @sorted = @sorted[0 .. $limit - 1] if (scalar(@sorted) > $limit);
1421 for my $s ( @sorted ) {
1422 my ($k) = keys(%$s);
1423 my ($v) = values(%$s);
1424 $$facets{$f}{$k} = $v;
1434 __PACKAGE__->register_method(
1435 method => "retrieve_cached_facets",
1436 api_name => "open-ils.search.facet_cache.retrieve",
1438 desc => 'Returns facet data derived from a specific search based on a key '.
1439 'generated by open-ils.search.biblio.multiclass.staged and friends.',
1442 desc => "The facet cache key returned with the initial search as the facet_key hash value",
1447 desc => 'Two level hash of facet values. Top level key is the facet id defined on the config.metabib_field table. '.
1448 'Second level key is a string facet value. Datum attached to each facet value is the number of distinct records, '.
1449 'or metarecords for a metarecord search, which use that facet value and are visible to the search at the time of '.
1450 'facet retrieval. These counts are calculated for all superpages that have been checked for visibility.',
1458 # add facets for this search to the facet cache
1459 my($key, $results, $metabib, $ignore) = @_;
1460 my $data = $cache->get_cache($key);
1463 return undef unless (@$results);
1465 my $facets_function = $metabib ? 'search.facets_for_metarecord_set'
1466 : 'search.facets_for_record_set';
1467 my $results_str = '{' . join(',', @$results) . '}';
1468 my $ignore_str = ref($ignore) ? '{' . join(',', @$ignore) . '}'
1471 from => [ $facets_function, $ignore_str, $results_str ]
1474 my $facets = OpenILS::Utils::CStoreEditor->new->json_query($query, {substream => 1});
1476 for my $facet (@$facets) {
1477 next unless ($facet->{value});
1478 $data->{$facet->{id}}->{$facet->{value}} += $facet->{count};
1481 $logger->info("facet compilation: cached with key=$key");
1483 $cache->put_cache($key, $data, $cache_timeout);
1484 $cache->put_cache($key.'_COMPLETE', 1, $cache_timeout);
1487 sub cache_staged_search_page {
1488 # puts this set of results into the cache
1489 my($key, $page, $summary, $results) = @_;
1490 my $data = $cache->get_cache($key);
1493 summary => $summary,
1497 $logger->info("staged search: cached with key=$key, superpage=$page, estimated=".
1498 ($summary->{estimated_hit_count} || "none") .
1499 ", visible=" . ($summary->{visible} || "none")
1502 $cache->put_cache($key, $data, $cache_timeout);
1510 my $start = $offset;
1511 my $end = $offset + $limit - 1;
1513 $logger->debug("searching cache for $key : $start..$end\n");
1515 return undef unless $cache;
1516 my $data = $cache->get_cache($key);
1518 return undef unless $data;
1520 my $count = $data->[0];
1523 return undef unless $offset < $count;
1526 for( my $i = $offset; $i <= $end; $i++ ) {
1527 last unless my $d = $$data[$i];
1528 push( @result, $d );
1531 $logger->debug("search_cache found ".scalar(@result)." items for count=$count, start=$start, end=$end");
1538 my( $key, $count, $data ) = @_;
1539 return undef unless $cache;
1540 $logger->debug("search_cache putting ".
1541 scalar(@$data)." items at key $key with timeout $cache_timeout");
1542 $cache->put_cache($key, [ $count, $data ], $cache_timeout);
1546 __PACKAGE__->register_method(
1547 method => "biblio_mrid_to_modsbatch_batch",
1548 api_name => "open-ils.search.biblio.metarecord.mods_slim.batch.retrieve"
1551 sub biblio_mrid_to_modsbatch_batch {
1552 my( $self, $client, $mrids) = @_;
1553 # warn "Performing mrid_to_modsbatch_batch..."; # unconditional warn
1555 my $method = $self->method_lookup("open-ils.search.biblio.metarecord.mods_slim.retrieve");
1556 for my $id (@$mrids) {
1557 next unless defined $id;
1558 my ($m) = $method->run($id);
1565 foreach (qw /open-ils.search.biblio.metarecord.mods_slim.retrieve
1566 open-ils.search.biblio.metarecord.mods_slim.retrieve.staff/)
1568 __PACKAGE__->register_method(
1569 method => "biblio_mrid_to_modsbatch",
1572 desc => "Returns the mvr associated with a given metarecod. If none exists, it is created. "
1573 . "As usual, the .staff version of this method will include otherwise hidden records.",
1575 { desc => 'Metarecord ID', type => 'number' },
1576 { desc => '(Optional) Search filters hash with possible keys: format, org, depth', type => 'object' }
1579 desc => 'MVR Object, event on error',
1585 sub biblio_mrid_to_modsbatch {
1586 my( $self, $client, $mrid, $args) = @_;
1588 # warn "Grabbing mvr for $mrid\n"; # unconditional warn
1590 my ($mr, $evt) = _grab_metarecord($mrid);
1591 return $evt unless $mr;
1593 my $mvr = biblio_mrid_check_mvr($self, $client, $mr) ||
1594 biblio_mrid_make_modsbatch($self, $client, $mr);
1596 return $mvr unless ref($args);
1598 # Here we find the lead record appropriate for the given filters
1599 # and use that for the title and author of the metarecord
1600 my $format = $$args{format};
1601 my $org = $$args{org};
1602 my $depth = $$args{depth};
1604 return $mvr unless $format or $org or $depth;
1606 my $method = "open-ils.storage.ordered.metabib.metarecord.records";
1607 $method = "$method.staff" if $self->api_name =~ /staff/o;
1609 my $rec = $U->storagereq($method, $format, $org, $depth, 1);
1611 if( my $mods = $U->record_to_mvr($rec) ) {
1613 $mvr->title( $mods->title );
1614 $mvr->author($mods->author);
1615 $logger->debug("mods_slim updating title and ".
1616 "author in mvr with ".$mods->title." : ".$mods->author);
1622 # converts a metarecord to an mvr
1625 my $perl = OpenSRF::Utils::JSON->JSON2perl($mr->mods());
1626 return Fieldmapper::metabib::virtual_record->new($perl);
1629 # checks to see if a metarecord has mods, if so returns true;
1631 __PACKAGE__->register_method(
1632 method => "biblio_mrid_check_mvr",
1633 api_name => "open-ils.search.biblio.metarecord.mods_slim.check",
1634 notes => "Takes a metarecord ID or a metarecord object and returns true "
1635 . "if the metarecord already has an mvr associated with it."
1638 sub biblio_mrid_check_mvr {
1639 my( $self, $client, $mrid ) = @_;
1643 if(ref($mrid)) { $mr = $mrid; }
1644 else { ($mr, $evt) = _grab_metarecord($mrid); }
1645 return $evt if $evt;
1647 # warn "Checking mvr for mr " . $mr->id . "\n"; # unconditional warn
1649 return _mr_to_mvr($mr) if $mr->mods();
1653 sub _grab_metarecord {
1655 my $e = new_editor();
1656 my $mr = $e->retrieve_metabib_metarecord($mrid) or return ( undef, $e->event );
1661 __PACKAGE__->register_method(
1662 method => "biblio_mrid_make_modsbatch",
1663 api_name => "open-ils.search.biblio.metarecord.mods_slim.create",
1664 notes => "Takes either a metarecord ID or a metarecord object. "
1665 . "Forces the creations of an mvr for the given metarecord. "
1666 . "The created mvr is returned."
1669 sub biblio_mrid_make_modsbatch {
1670 my( $self, $client, $mrid ) = @_;
1672 my $e = new_editor();
1679 $mr = $e->retrieve_metabib_metarecord($mrid)
1680 or return $e->event;
1683 my $masterid = $mr->master_record;
1684 $logger->info("creating new mods batch for metarecord=$mrid, master record=$masterid");
1686 my $ids = $U->storagereq(
1687 'open-ils.storage.ordered.metabib.metarecord.records.staff.atomic', $mrid);
1688 return undef unless @$ids;
1690 my $master = $e->retrieve_biblio_record_entry($masterid)
1691 or return $e->event;
1693 # start the mods batch
1694 my $u = OpenILS::Utils::ModsParser->new();
1695 $u->start_mods_batch( $master->marc );
1697 # grab all of the sub-records and shove them into the batch
1698 my @ids = grep { $_ ne $masterid } @$ids;
1699 #my $subrecs = (@ids) ? $e->batch_retrieve_biblio_record_entry(\@ids) : [];
1704 my $r = $e->retrieve_biblio_record_entry($i);
1705 push( @$subrecs, $r ) if $r;
1710 $logger->debug("adding record ".$_->id." to mods batch for metarecord=$mrid");
1711 $u->push_mods_batch( $_->marc ) if $_->marc;
1715 # finish up and send to the client
1716 my $mods = $u->finish_mods_batch();
1717 $mods->doc_id($mrid);
1718 $client->respond_complete($mods);
1721 # now update the mods string in the db
1722 my $string = OpenSRF::Utils::JSON->perl2JSON($mods->decast);
1725 $e = new_editor(xact => 1);
1726 $e->update_metabib_metarecord($mr)
1727 or $logger->error("Error setting mods text on metarecord $mrid : " . Dumper($e->event));
1734 # converts a mr id into a list of record ids
1736 foreach (qw/open-ils.search.biblio.metarecord_to_records
1737 open-ils.search.biblio.metarecord_to_records.staff/)
1739 __PACKAGE__->register_method(
1740 method => "biblio_mrid_to_record_ids",
1743 desc => "Fetch record IDs corresponding to a meta-record ID, with optional search filters. "
1744 . "As usual, the .staff version of this method will include otherwise hidden records.",
1746 { desc => 'Metarecord ID', type => 'number' },
1747 { desc => '(Optional) Search filters hash with possible keys: format, org, depth', type => 'object' }
1750 desc => 'Results object like {count => $i, ids =>[...]}',
1758 sub biblio_mrid_to_record_ids {
1759 my( $self, $client, $mrid, $args ) = @_;
1761 my $format = $$args{format};
1762 my $org = $$args{org};
1763 my $depth = $$args{depth};
1765 my $method = "open-ils.storage.ordered.metabib.metarecord.records.atomic";
1766 $method =~ s/atomic/staff\.atomic/o if $self->api_name =~ /staff/o;
1767 my $recs = $U->storagereq($method, $mrid, $format, $org, $depth);
1769 return { count => scalar(@$recs), ids => $recs };
1773 __PACKAGE__->register_method(
1774 method => "biblio_record_to_marc_html",
1775 api_name => "open-ils.search.biblio.record.html"
1778 __PACKAGE__->register_method(
1779 method => "biblio_record_to_marc_html",
1780 api_name => "open-ils.search.authority.to_html"
1783 # Persistent parsers and setting objects
1784 my $parser = XML::LibXML->new();
1785 my $xslt = XML::LibXSLT->new();
1787 my $slim_marc_sheet;
1788 my $settings_client = OpenSRF::Utils::SettingsClient->new();
1790 sub biblio_record_to_marc_html {
1791 my($self, $client, $recordid, $slim, $marcxml) = @_;
1794 my $dir = $settings_client->config_value("dirs", "xsl");
1797 unless($slim_marc_sheet) {
1798 my $xsl = $settings_client->config_value(
1799 "apps", "open-ils.search", "app_settings", 'marc_html_xsl_slim');
1801 $xsl = $parser->parse_file("$dir/$xsl");
1802 $slim_marc_sheet = $xslt->parse_stylesheet($xsl);
1805 $sheet = $slim_marc_sheet;
1809 unless($marc_sheet) {
1810 my $xsl_key = ($slim) ? 'marc_html_xsl_slim' : 'marc_html_xsl';
1811 my $xsl = $settings_client->config_value(
1812 "apps", "open-ils.search", "app_settings", 'marc_html_xsl');
1813 $xsl = $parser->parse_file("$dir/$xsl");
1814 $marc_sheet = $xslt->parse_stylesheet($xsl);
1816 $sheet = $marc_sheet;
1821 my $e = new_editor();
1822 if($self->api_name =~ /authority/) {
1823 $record = $e->retrieve_authority_record_entry($recordid)
1824 or return $e->event;
1826 $record = $e->retrieve_biblio_record_entry($recordid)
1827 or return $e->event;
1829 $marcxml = $record->marc;
1832 my $xmldoc = $parser->parse_string($marcxml);
1833 my $html = $sheet->transform($xmldoc);
1834 return $html->documentElement->toString();
1837 __PACKAGE__->register_method(
1838 method => "send_event_email_output",
1839 api_name => "open-ils.search.biblio.record.email.send_output",
1841 sub send_event_email_output {
1842 my($self, $client, $auth, $event_id, $capkey, $capanswer) = @_;
1843 return undef unless $event_id;
1845 my $captcha_pass = 0;
1848 $real_answer = $cache->get_cache(md5_hex($capkey));
1849 $captcha_pass++ if ($real_answer eq $capanswer);
1852 my $e = new_editor(authtoken => $auth);
1853 return $e->die_event unless $captcha_pass || $e->checkauth;
1855 my $event = $e->retrieve_action_trigger_event([$event_id,{flesh => 1, flesh_fields => { atev => ['template_output']}}]);
1856 return undef unless ($event and $event->template_output);
1858 my $smtp = OpenSRF::Utils::SettingsClient
1860 ->config_value('email_notify', 'smtp_server');
1862 my $sender = Email::Send->new({mailer => 'SMTP'});
1863 $sender->mailer_args([Host => $smtp]);
1868 my $email = Email::Simple->new($event->template_output->data);
1870 for my $hfield (qw/From To Subject Bcc Cc Reply-To Sender/) {
1871 my @headers = $email->header($hfield);
1872 $email->header_set($hfield => map { encode("MIME-Header", $_) } @headers) if ($headers[0]);
1875 $email->header_set('MIME-Version' => '1.0');
1876 $email->header_set('Content-Type' => "text/plain; charset=UTF-8");
1877 $email->header_set('Content-Transfer-Encoding' => '8bit');
1880 $stat = $sender->send($email);
1881 } catch Error with {
1882 $err = $stat = shift;
1883 $logger->error("send_event_email_output: Email failed with error: $err");
1886 if( !$err and $stat and $stat->type eq 'success' ) {
1887 $logger->info("send_event_email_output: successfully sent email");
1890 $logger->warn("send_event_email_output: unable to send email: ".Dumper($stat));
1895 __PACKAGE__->register_method(
1896 method => "format_biblio_record_entry",
1897 api_name => "open-ils.search.biblio.record.print.preview",
1900 __PACKAGE__->register_method(
1901 method => "format_biblio_record_entry",
1902 api_name => "open-ils.search.biblio.record.email.preview",
1905 __PACKAGE__->register_method(
1906 method => "format_biblio_record_entry",
1907 api_name => "open-ils.search.biblio.record.print",
1909 desc => 'Returns a printable version of the specified bib record',
1911 { desc => 'Biblio record entry ID or array of IDs', type => 'number' },
1912 { desc => 'Context library for holdings, if applicable' => 'number' },
1913 { desc => 'Sort order, if applicable' => 'string' },
1914 { desc => 'Definition Group Member id' => 'number' },
1917 desc => q/An action_trigger.event object or error event./,
1922 __PACKAGE__->register_method(
1923 method => "format_biblio_record_entry",
1924 api_name => "open-ils.search.biblio.record.email",
1926 desc => 'Emails an A/T templated version of the specified bib records to the authorized user',
1928 { desc => 'Authentication token', type => 'string'},
1929 { desc => 'Biblio record entry ID or array of IDs', type => 'number' },
1930 { desc => 'Context library for holdings, if applicable' => 'number' },
1931 { desc => 'Sort order, if applicable' => 'string' },
1932 { desc => 'Sort direction, if applicable' => 'string' },
1933 { desc => 'Definition Group Member id' => 'number' },
1934 { desc => 'Whether to bypass auth due to captcha' => 'bool' },
1935 { desc => 'Email address, if none for the user' => 'string' },
1936 { desc => 'Subject, if customized' => 'string' },
1939 desc => q/Undefined on success, otherwise an error event./,
1945 sub format_biblio_record_entry {
1946 my($self, $conn, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6, $captcha_pass, $email, $subject) = @_;
1948 my $for_print = ($self->api_name =~ /print/);
1949 my $for_email = ($self->api_name =~ /email/);
1950 my $preview = ($self->api_name =~ /preview/);
1952 my $e; my $auth; my $bib_id; my $context_org; my $holdings_context; my $bib_sort; my $group_member; my $type = 'brief'; my $sort_dir;
1956 $context_org = $arg2 || $U->get_org_tree->id;
1957 $holdings_context = $context_org;
1958 $bib_sort = $arg3 || 'author';
1959 $sort_dir = $arg4 || 'ascending';
1960 $group_member = $arg5;
1961 $e = new_editor(xact => 1);
1962 } elsif ($for_email) {
1965 $bib_sort = $arg4 || 'author';
1966 $sort_dir = $arg5 || 'ascending';
1967 $group_member = $arg6;
1968 $e = new_editor(authtoken => $auth, xact => 1);
1969 return $e->die_event unless $captcha_pass || $e->checkauth;
1970 $holdings_context = $arg3 || $U->get_org_tree->id;
1971 $context_org = $e->requestor ? $e->requestor->home_ou : $arg3;
1972 $email ||= $e->requestor ? $e->requestor->email : '';
1975 if ($group_member) {
1976 $group_member = $e->retrieve_action_trigger_event_def_group_member($group_member);
1977 if ($group_member and $U->is_true($group_member->holdings)) {
1982 $holdings_context = $e->retrieve_actor_org_unit($holdings_context);
1985 if (ref $bib_id ne 'ARRAY') {
1986 $bib_ids = [ $bib_id ];
1991 my $bucket = Fieldmapper::container::biblio_record_entry_bucket->new;
1992 $bucket->btype('temp');
1993 $bucket->name('format_biblio_record_entry ' . $U->create_uuid_string);
1995 $bucket->owner($e->requestor || 1)
1999 my $bucket_obj = $e->create_container_biblio_record_entry_bucket($bucket);
2001 for my $id (@$bib_ids) {
2003 my $bib = $e->retrieve_biblio_record_entry([$id]) or return $e->die_event;
2005 my $bucket_entry = Fieldmapper::container::biblio_record_entry_bucket_item->new;
2006 $bucket_entry->target_biblio_record_entry($bib);
2007 $bucket_entry->bucket($bucket_obj->id);
2008 $e->create_container_biblio_record_entry_bucket_item($bucket_entry);
2016 subject => $subject,
2017 context_org => $holdings_context->shortname,
2018 sort_by => $bib_sort,
2019 sort_dir => $sort_dir,
2025 return $U->fire_object_event(undef, 'biblio.format.record_entry.print', [ $bucket ], $context_org, undef, [ $usr_data ]);
2027 } elsif ($for_email) {
2029 return $U->fire_object_event(undef, 'biblio.format.record_entry.email', [ $bucket ], $context_org, undef, [ $usr_data ])
2032 $U->create_events_for_hook('biblio.format.record_entry.email', $bucket, $context_org, undef, $usr_data, 1);
2039 __PACKAGE__->register_method(
2040 method => "retrieve_all_copy_statuses",
2041 api_name => "open-ils.search.config.copy_status.retrieve.all"
2044 sub retrieve_all_copy_statuses {
2045 my( $self, $client ) = @_;
2046 return new_editor()->retrieve_all_config_copy_status();
2050 __PACKAGE__->register_method(
2051 method => "copy_counts_per_org",
2052 api_name => "open-ils.search.biblio.copy_counts.retrieve"
2055 __PACKAGE__->register_method(
2056 method => "copy_counts_per_org",
2057 api_name => "open-ils.search.biblio.copy_counts.retrieve.staff"
2060 sub copy_counts_per_org {
2061 my( $self, $client, $record_id ) = @_;
2063 warn "Retreiveing copy copy counts for record $record_id and method " . $self->api_name . "\n";
2065 my $method = "open-ils.storage.biblio.record_entry.global_copy_count.atomic";
2066 if($self->api_name =~ /staff/) { $method =~ s/atomic/staff\.atomic/; }
2068 my $counts = $apputils->simple_scalar_request(
2069 "open-ils.storage", $method, $record_id );
2071 $counts = [ sort {$a->[0] <=> $b->[0]} @$counts ];
2076 __PACKAGE__->register_method(
2077 method => "copy_count_summary",
2078 api_name => "open-ils.search.biblio.copy_counts.summary.retrieve",
2079 notes => "returns an array of these: "
2080 . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, <status1_count>, <status2_count>,...] "
2081 . "where statusx is a copy status name. The statuses are sorted by ID.",
2085 sub copy_count_summary {
2086 my( $self, $client, $rid, $org, $depth ) = @_;
2089 my $data = $U->storagereq(
2090 'open-ils.storage.biblio.record_entry.status_copy_count.atomic', $rid, $org, $depth );
2093 (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2095 (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2099 __PACKAGE__->register_method(
2100 method => "copy_location_count_summary",
2101 api_name => "open-ils.search.biblio.copy_location_counts.summary.retrieve",
2102 notes => "returns an array of these: "
2103 . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, copy_location, <status1_count>, <status2_count>,...] "
2104 . "where statusx is a copy status name. The statuses are sorted by ID.",
2107 sub copy_location_count_summary {
2108 my( $self, $client, $rid, $org, $depth ) = @_;
2111 my $data = $U->storagereq(
2112 'open-ils.storage.biblio.record_entry.status_copy_location_count.atomic', $rid, $org, $depth );
2115 (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2117 (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2119 || $a->[4] cmp $b->[4]
2123 __PACKAGE__->register_method(
2124 method => "copy_count_location_summary",
2125 api_name => "open-ils.search.biblio.copy_counts.location.summary.retrieve",
2126 notes => "returns an array of these: "
2127 . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, <status1_count>, <status2_count>,...] "
2128 . "where statusx is a copy status name. The statuses are sorted by ID."
2131 sub copy_count_location_summary {
2132 my( $self, $client, $rid, $org, $depth ) = @_;
2135 my $data = $U->storagereq(
2136 'open-ils.storage.biblio.record_entry.status_copy_location_count.atomic', $rid, $org, $depth );
2138 (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2140 (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2145 foreach (qw/open-ils.search.biblio.marc
2146 open-ils.search.biblio.marc.staff/)
2148 __PACKAGE__->register_method(
2149 method => "marc_search",
2152 desc => 'Fetch biblio IDs based on MARC record criteria. '
2153 . 'As usual, the .staff version of the search includes otherwise hidden records',
2156 desc => 'Search hash (required) with possible elements: searches, limit, offset, sort, sort_dir. ' .
2157 'See perldoc ' . __PACKAGE__ . ' for more detail.',
2160 {desc => 'timeout (optional)', type => 'number'}
2163 desc => 'Results object like: { "count": $i, "ids": [...] }',
2170 =head3 open-ils.search.biblio.marc (arghash, timeout)
2172 As elsewhere the arghash is the required argument, and must be a hashref. The keys are:
2174 searches: complex query object (required)
2175 org_unit: The org ID to focus the search at
2176 depth : The org depth
2177 limit : integer search limit default: 10
2178 offset : integer search offset default: 0
2179 sort : What field to sort the results on? [ author | title | pubdate ]
2180 sort_dir: In what direction do we sort? [ asc | desc ]
2182 Additional keys to refine search criteria:
2185 language : Language (code)
2186 lit_form : Literary form
2187 item_form: Item form
2188 item_type: Item type
2189 format : The MARC format
2191 Please note that the specific strings to be used in the "addtional keys" will be entirely
2192 dependent on your loaded data.
2194 All keys except "searches" are optional.
2195 The "searches" value must be an arrayref of hashref elements, including keys "term" and "restrict".
2197 For example, an arg hash might look like:
2219 The arghash is eventually passed to the SRF call:
2220 L<open-ils.storage.biblio.full_rec.multi_search[.staff].atomic>
2222 Presently, search uses the cache unconditionally.
2226 # FIXME: that example above isn't actually tested.
2227 # FIXME: sort and limit added. item_type not tested yet.
2228 # TODO: docache option?
2230 my( $self, $conn, $args, $timeout ) = @_;
2232 my $method = 'open-ils.storage.biblio.full_rec.multi_search';
2233 $method .= ".staff" if $self->api_name =~ /staff/;
2234 $method .= ".atomic";
2236 my $limit = $args->{limit} || 10;
2237 my $offset = $args->{offset} || 0;
2239 # allow caller to pass in a call timeout since MARC searches
2240 # can take longer than the default 60-second timeout.
2241 # Default to 2 mins. Arbitrarily cap at 5 mins.
2242 $timeout = 120 if !$timeout or $timeout > 300;
2245 push( @search, ($_ => $$args{$_}) ) for (sort keys %$args);
2246 my $ckey = $pfx . md5_hex($method . OpenSRF::Utils::JSON->perl2JSON(\@search));
2248 my $recs = search_cache($ckey, $offset, $limit);
2252 my $ses = OpenSRF::AppSession->create('open-ils.storage');
2253 my $req = $ses->request($method, %$args);
2254 my $resp = $req->recv($timeout);
2256 if($resp and $recs = $resp->content) {
2257 put_cache($ckey, scalar(@$recs), $recs);
2266 $count = $recs->[0]->[2] if $recs->[0] and $recs->[0]->[2];
2267 my @recs = map { $_->[0] } @$recs;
2269 return { ids => \@recs, count => $count };
2273 foreach my $isbn_method (qw/
2274 open-ils.search.biblio.isbn
2275 open-ils.search.biblio.isbn.staff
2277 __PACKAGE__->register_method(
2278 method => "biblio_search_isbn",
2279 api_name => $isbn_method,
2281 desc => 'Retrieve biblio IDs for a given ISBN. The .staff version of the call includes otherwise hidden hits.',
2283 {desc => 'ISBN', type => 'string'}
2286 desc => 'Results object like: { "count": $i, "ids": [...] }',
2293 sub biblio_search_isbn {
2294 my( $self, $client, $isbn ) = @_;
2295 $logger->debug("Searching ISBN $isbn");
2296 # the previous implementation of this method was essentially unlimited,
2297 # so we will set our limit very high and let multiclass.query provide any
2299 # XXX: if making this unlimited is deemed important, we might consider
2300 # reworking 'open-ils.storage.id_list.biblio.record_entry.search.isbn',
2301 # which is functionally deprecated at this point, or a custom call to
2302 # 'open-ils.storage.biblio.multiclass.search_fts'
2304 my $isbn_method = 'open-ils.search.biblio.multiclass.query';
2305 if ($self->api_name =~ m/.staff$/) {
2306 $isbn_method .= '.staff';
2309 my $method = $self->method_lookup($isbn_method);
2310 my ($search_result) = $method->run({'limit' => 1000000}, "identifier|isbn:$isbn");
2311 my @recs = map { $_->[0] } @{$search_result->{'ids'}};
2312 return { ids => \@recs, count => $search_result->{'count'} };
2315 __PACKAGE__->register_method(
2316 method => "biblio_search_isbn_batch",
2317 api_name => "open-ils.search.biblio.isbn_list",
2320 # XXX: see biblio_search_isbn() for note concerning 'limit'
2321 sub biblio_search_isbn_batch {
2322 my( $self, $client, $isbn_list ) = @_;
2323 $logger->debug("Searching ISBNs @$isbn_list");
2324 my @recs = (); my %rec_set = ();
2325 my $method = $self->method_lookup('open-ils.search.biblio.multiclass.query');
2326 foreach my $isbn ( @$isbn_list ) {
2327 my ($search_result) = $method->run({'limit' => 1000000}, "identifier|isbn:$isbn");
2328 my @recs_subset = map { $_->[0] } @{$search_result->{'ids'}};
2329 foreach my $rec (@recs_subset) {
2330 if (! $rec_set{ $rec }) {
2331 $rec_set{ $rec } = 1;
2336 return { ids => \@recs, count => scalar(@recs) };
2339 foreach my $issn_method (qw/
2340 open-ils.search.biblio.issn
2341 open-ils.search.biblio.issn.staff
2343 __PACKAGE__->register_method(
2344 method => "biblio_search_issn",
2345 api_name => $issn_method,
2347 desc => 'Retrieve biblio IDs for a given ISSN',
2349 {desc => 'ISBN', type => 'string'}
2352 desc => 'Results object like: { "count": $i, "ids": [...] }',
2359 sub biblio_search_issn {
2360 my( $self, $client, $issn ) = @_;
2361 $logger->debug("Searching ISSN $issn");
2362 # the previous implementation of this method was essentially unlimited,
2363 # so we will set our limit very high and let multiclass.query provide any
2365 # XXX: if making this unlimited is deemed important, we might consider
2366 # reworking 'open-ils.storage.id_list.biblio.record_entry.search.issn',
2367 # which is functionally deprecated at this point, or a custom call to
2368 # 'open-ils.storage.biblio.multiclass.search_fts'
2370 my $issn_method = 'open-ils.search.biblio.multiclass.query';
2371 if ($self->api_name =~ m/.staff$/) {
2372 $issn_method .= '.staff';
2375 my $method = $self->method_lookup($issn_method);
2376 my ($search_result) = $method->run({'limit' => 1000000}, "identifier|issn:$issn");
2377 my @recs = map { $_->[0] } @{$search_result->{'ids'}};
2378 return { ids => \@recs, count => $search_result->{'count'} };
2382 __PACKAGE__->register_method(
2383 method => "fetch_mods_by_copy",
2384 api_name => "open-ils.search.biblio.mods_from_copy",
2387 desc => 'Retrieve MODS record given an attached copy ID',
2389 { desc => 'Copy ID', type => 'number' }
2392 desc => 'MODS record, event on error or uncataloged item'
2397 sub fetch_mods_by_copy {
2398 my( $self, $client, $copyid ) = @_;
2399 my ($record, $evt) = $apputils->fetch_record_by_copy( $copyid );
2400 return $evt if $evt;
2401 return OpenILS::Event->new('ITEM_NOT_CATALOGED') unless $record->marc;
2402 return $apputils->record_to_mvr($record);
2406 # -------------------------------------------------------------------------------------
2408 __PACKAGE__->register_method(
2409 method => "cn_browse",
2410 api_name => "open-ils.search.callnumber.browse.target",
2411 notes => "Starts a callnumber browse"
2414 __PACKAGE__->register_method(
2415 method => "cn_browse",
2416 api_name => "open-ils.search.callnumber.browse.page_up",
2417 notes => "Returns the previous page of callnumbers",
2420 __PACKAGE__->register_method(
2421 method => "cn_browse",
2422 api_name => "open-ils.search.callnumber.browse.page_down",
2423 notes => "Returns the next page of callnumbers",
2427 # RETURNS array of arrays like so: label, owning_lib, record, id
2429 my( $self, $client, @params ) = @_;
2432 $method = 'open-ils.storage.asset.call_number.browse.target.atomic'
2433 if( $self->api_name =~ /target/ );
2434 $method = 'open-ils.storage.asset.call_number.browse.page_up.atomic'
2435 if( $self->api_name =~ /page_up/ );
2436 $method = 'open-ils.storage.asset.call_number.browse.page_down.atomic'
2437 if( $self->api_name =~ /page_down/ );
2439 return $apputils->simplereq( 'open-ils.storage', $method, @params );
2441 # -------------------------------------------------------------------------------------
2443 __PACKAGE__->register_method(
2444 method => "fetch_cn",
2445 api_name => "open-ils.search.callnumber.retrieve",
2447 notes => "retrieves a callnumber based on ID",
2451 my( $self, $client, $id ) = @_;
2453 my $e = new_editor();
2454 my( $cn, $evt ) = $apputils->fetch_callnumber( $id, 0, $e );
2455 return $evt if $evt;
2459 __PACKAGE__->register_method(
2460 method => "fetch_fleshed_cn",
2461 api_name => "open-ils.search.callnumber.fleshed.retrieve",
2463 notes => "retrieves a callnumber based on ID, fleshing prefix, suffix, and label_class",
2466 sub fetch_fleshed_cn {
2467 my( $self, $client, $id ) = @_;
2469 my $e = new_editor();
2470 my( $cn, $evt ) = $apputils->fetch_callnumber( $id, 1, $e );
2471 return $evt if $evt;
2476 __PACKAGE__->register_method(
2477 method => "fetch_copy_by_cn",
2478 api_name => 'open-ils.search.copies_by_call_number.retrieve',
2480 Returns an array of copy ID's by callnumber ID
2481 @param cnid The callnumber ID
2482 @return An array of copy IDs
2486 sub fetch_copy_by_cn {
2487 my( $self, $conn, $cnid ) = @_;
2488 return $U->cstorereq(
2489 'open-ils.cstore.direct.asset.copy.id_list.atomic',
2490 { call_number => $cnid, deleted => 'f' } );
2493 __PACKAGE__->register_method(
2494 method => 'fetch_cn_by_info',
2495 api_name => 'open-ils.search.call_number.retrieve_by_info',
2497 @param label The callnumber label
2498 @param record The record the cn is attached to
2499 @param org The owning library of the cn
2500 @return The callnumber object
2505 sub fetch_cn_by_info {
2506 my( $self, $conn, $label, $record, $org ) = @_;
2507 return $U->cstorereq(
2508 'open-ils.cstore.direct.asset.call_number.search',
2509 { label => $label, record => $record, owning_lib => $org, deleted => 'f' });
2514 __PACKAGE__->register_method(
2515 method => 'bib_extras',
2516 api_name => 'open-ils.search.biblio.lit_form_map.retrieve.all',
2519 __PACKAGE__->register_method(
2520 method => 'bib_extras',
2521 api_name => 'open-ils.search.biblio.item_form_map.retrieve.all',
2522 ctype => 'item_form'
2524 __PACKAGE__->register_method(
2525 method => 'bib_extras',
2526 api_name => 'open-ils.search.biblio.item_type_map.retrieve.all',
2527 ctype => 'item_type',
2529 __PACKAGE__->register_method(
2530 method => 'bib_extras',
2531 api_name => 'open-ils.search.biblio.bib_level_map.retrieve.all',
2532 ctype => 'bib_level'
2534 __PACKAGE__->register_method(
2535 method => 'bib_extras',
2536 api_name => 'open-ils.search.biblio.audience_map.retrieve.all',
2542 $logger->warn("deprecation warning: " .$self->api_name);
2544 my $e = new_editor();
2546 my $ctype = $self->{ctype};
2547 my $ccvms = $e->search_config_coded_value_map({ctype => $ctype});
2550 for my $ccvm (@$ccvms) {
2551 my $obj = "Fieldmapper::config::${ctype}_map"->new;
2552 $obj->value($ccvm->value);
2553 $obj->code($ccvm->code);
2554 $obj->description($ccvm->description) if $obj->can('description');
2563 __PACKAGE__->register_method(
2564 method => 'fetch_slim_record',
2565 api_name => 'open-ils.search.biblio.record_entry.slim.retrieve',
2567 desc => "Retrieves one or more biblio.record_entry without the attached marcxml",
2569 { desc => 'Array of Record IDs', type => 'array' }
2572 desc => 'Array of biblio records, event on error'
2577 sub fetch_slim_record {
2578 my( $self, $conn, $ids ) = @_;
2580 my $editor = new_editor();
2583 return $editor->event unless
2584 my $r = $editor->retrieve_biblio_record_entry($_);
2591 __PACKAGE__->register_method(
2592 method => 'rec_hold_parts',
2593 api_name => 'open-ils.search.biblio.record_hold_parts',
2595 Returns a list of {label :foo, id : bar} objects for viable monograph parts for a given record
2599 sub rec_hold_parts {
2600 my( $self, $conn, $args ) = @_;
2602 my $rec = $$args{record};
2603 my $mrec = $$args{metarecord};
2604 my $pickup_lib = $$args{pickup_lib};
2605 my $e = new_editor();
2608 select => {bmp => ['id', 'label']},
2613 select => {'acpm' => ['part']},
2614 from => {acpm => {acp => {join => {acn => {join => 'bre'}}}}},
2616 '+acp' => {'deleted' => 'f'},
2617 '+bre' => {id => $rec}
2624 order_by =>[{class=>'bmp', field=>'label_sortkey'}]
2627 if(defined $pickup_lib) {
2628 my $hard_boundary = $U->ou_ancestor_setting_value($pickup_lib, OILS_SETTING_HOLD_HARD_BOUNDARY);
2629 if($hard_boundary) {
2630 my $orgs = $e->json_query({from => ['actor.org_unit_descendants' => $pickup_lib, $hard_boundary]});
2631 $query->{where}->{'+acp'}->{circ_lib} = [ map { $_->{id} } @$orgs ];
2635 return $e->json_query($query);
2641 __PACKAGE__->register_method(
2642 method => 'rec_to_mr_rec_descriptors',
2643 api_name => 'open-ils.search.metabib.record_to_descriptors',
2645 specialized method...
2646 Given a biblio record id or a metarecord id,
2647 this returns a list of metabib.record_descriptor
2648 objects that live within the same metarecord
2649 @param args Object of args including:
2653 sub rec_to_mr_rec_descriptors {
2654 my( $self, $conn, $args ) = @_;
2656 my $rec = $$args{record};
2657 my $mrec = $$args{metarecord};
2658 my $item_forms = $$args{item_forms};
2659 my $item_types = $$args{item_types};
2660 my $item_lang = $$args{item_lang};
2661 my $pickup_lib = $$args{pickup_lib};
2663 my $hard_boundary = $U->ou_ancestor_setting_value($pickup_lib, OILS_SETTING_HOLD_HARD_BOUNDARY) if (defined $pickup_lib);
2665 my $e = new_editor();
2669 my $map = $e->search_metabib_metarecord_source_map({source => $rec});
2670 return $e->event unless @$map;
2671 $mrec = $$map[0]->metarecord;
2674 $recs = $e->search_metabib_metarecord_source_map({metarecord => $mrec});
2675 return $e->event unless @$recs;
2677 my @recs = map { $_->source } @$recs;
2678 my $search = { record => \@recs };
2679 $search->{item_form} = $item_forms if $item_forms and @$item_forms;
2680 $search->{item_type} = $item_types if $item_types and @$item_types;
2681 $search->{item_lang} = $item_lang if $item_lang;
2683 my $desc = $e->search_metabib_record_descriptor($search);
2687 select => { 'bre' => ['id'] },
2692 'acp' => {"join" => {"acpl" => {}, "ccs" => {}}}
2698 '+bre' => { id => \@recs },
2703 "+ccs" => { holdable => 't' },
2704 "+acpl" => { holdable => 't', deleted => 'f' }
2708 if ($hard_boundary) { # 0 (or "top") is the same as no setting
2709 my $orgs = $e->json_query(
2710 { from => [ 'actor.org_unit_descendants' => $pickup_lib, $hard_boundary ] }
2711 ) or return $e->die_event;
2713 $query->{where}->{"+acp"}->{circ_lib} = [ map { $_->{id} } @$orgs ];
2716 my $good_records = $e->json_query($query) or return $e->die_event;
2719 for my $d (@$desc) {
2720 if ( grep { $d->record == $_->{id} } @$good_records ) {
2727 return { metarecord => $mrec, descriptors => $desc };
2731 __PACKAGE__->register_method(
2732 method => 'fetch_age_protect',
2733 api_name => 'open-ils.search.copy.age_protect.retrieve.all',
2736 sub fetch_age_protect {
2737 return new_editor()->retrieve_all_config_rule_age_hold_protect();
2741 __PACKAGE__->register_method(
2742 method => 'copies_by_cn_label',
2743 api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label',
2746 __PACKAGE__->register_method(
2747 method => 'copies_by_cn_label',
2748 api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label.staff',
2751 sub copies_by_cn_label {
2752 my( $self, $conn, $record, $cn_parts, $circ_lib ) = @_;
2753 my $e = new_editor();
2754 my $cnp_id = $cn_parts->[0] eq '' ? -1 : $e->search_asset_call_number_prefix({label => $cn_parts->[0]}, {idlist=>1})->[0];
2755 my $cns_id = $cn_parts->[2] eq '' ? -1 : $e->search_asset_call_number_suffix({label => $cn_parts->[2]}, {idlist=>1})->[0];
2756 my $cns = $e->search_asset_call_number({record => $record, prefix => $cnp_id, label => $cn_parts->[1], suffix => $cns_id, deleted => 'f'}, {idlist=>1});
2757 return [] unless @$cns;
2759 # show all non-deleted copies in the staff client ...
2760 if ($self->api_name =~ /staff$/o) {
2761 return $e->search_asset_copy({call_number => $cns, circ_lib => $circ_lib, deleted => 'f'}, {idlist=>1});
2764 # ... otherwise, grab the copies ...
2765 my $copies = $e->search_asset_copy(
2766 [ {call_number => $cns, circ_lib => $circ_lib, deleted => 'f', opac_visible => 't'},
2767 {flesh => 1, flesh_fields => { acp => [ qw/location status/] } }
2771 # ... and test for location and status visibility
2772 return [ map { ($U->is_true($_->location->opac_visible) && $U->is_true($_->status->opac_visible)) ? ($_->id) : () } @$copies ];
2775 __PACKAGE__->register_method(
2776 method => 'bib_copies',
2777 api_name => 'open-ils.search.bib.copies',
2780 __PACKAGE__->register_method(
2781 method => 'bib_copies',
2782 api_name => 'open-ils.search.bib.copies.staff',
2787 my ($self, $client, $rec_id, $org, $depth, $limit, $offset, $pref_ou) = @_;
2788 my $is_staff = ($self->api_name =~ /staff/);
2790 my $cstore = OpenSRF::AppSession->create('open-ils.cstore');
2791 my $req = $cstore->request(
2792 'open-ils.cstore.json_query', mk_copy_query(
2793 $rec_id, $org, $depth, $limit, $offset, $pref_ou, $is_staff));
2796 while ($resp = $req->recv) {
2797 $client->respond($resp->content);
2803 # TODO: this comes almost directly from WWW/EGCatLoader/Record.pm
2809 my $copy_limit = shift;
2810 my $copy_offset = shift;
2811 my $pref_ou = shift;
2812 my $is_staff = shift;
2814 my $query = $U->basic_opac_copy_query(
2815 $rec_id, undef, undef, $copy_limit, $copy_offset, $is_staff
2818 if ($org) { # TODO: root org test
2819 # no need to add the org join filter if we're not actually filtering
2820 $query->{from}->{acp}->[1] = { aou => {
2826 select => {aou => [{
2828 transform => 'actor.org_unit_descendants',
2829 result_field => 'id',
2833 where => {id => $org}
2840 # Unsure if we want these in the shared function, leaving here for now
2841 unshift(@{$query->{order_by}},
2842 { class => "aou", field => 'id',
2843 transform => 'evergreen.rank_ou', params => [$org, $pref_ou]
2846 push(@{$query->{order_by}},
2847 { class => "acp", field => 'id',
2848 transform => 'evergreen.rank_cp'
2856 __PACKAGE__->register_method(
2857 method => 'catalog_record_summary',
2858 api_name => 'open-ils.search.biblio.record.catalog_summary',
2860 max_bundle_count => 1,
2862 desc => 'Stream of record data suitable for catalog display',
2864 {desc => 'Context org unit ID', type => 'number'},
2865 {desc => 'Array of Record IDs', type => 'array'}
2869 Stream of record summary objects including id, record,
2870 hold_count, copy_counts, display (metabib display
2871 fields), attributes (metabib record attrs), plus
2872 metabib_id and metabib_records for the metabib variant.
2877 __PACKAGE__->register_method(
2878 method => 'catalog_record_summary',
2879 api_name => 'open-ils.search.biblio.record.catalog_summary.staff',
2881 max_bundle_count => 1,
2882 signature => q/see open-ils.search.biblio.record.catalog_summary/
2884 __PACKAGE__->register_method(
2885 method => 'catalog_record_summary',
2886 api_name => 'open-ils.search.biblio.metabib.catalog_summary',
2888 max_bundle_count => 1,
2889 signature => q/see open-ils.search.biblio.record.catalog_summary/
2892 __PACKAGE__->register_method(
2893 method => 'catalog_record_summary',
2894 api_name => 'open-ils.search.biblio.metabib.catalog_summary.staff',
2896 max_bundle_count => 1,
2897 signature => q/see open-ils.search.biblio.record.catalog_summary/
2901 sub catalog_record_summary {
2902 my ($self, $client, $org_id, $record_ids) = @_;
2903 my $e = new_editor();
2905 my $is_meta = ($self->api_name =~ /metabib/);
2906 my $is_staff = ($self->api_name =~ /staff/);
2908 my $holds_method = $is_meta ?
2909 'open-ils.circ.mmr.holds.count' :
2910 'open-ils.circ.bre.holds.count';
2912 my $copy_method = $is_meta ?
2913 'open-ils.search.biblio.metarecord.copy_count':
2914 'open-ils.search.biblio.record.copy_count';
2916 $copy_method .= '.staff' if $is_staff;
2918 $copy_method = $self->method_lookup($copy_method); # local method
2920 for my $rec_id (@$record_ids) {
2922 my $response = $is_meta ?
2923 get_one_metarecord_summary($e, $rec_id) :
2924 get_one_record_summary($e, $rec_id);
2926 ($response->{copy_counts}) = $copy_method->run($org_id, $rec_id);
2928 $response->{hold_count} =
2929 $U->simplereq('open-ils.circ', $holds_method, $rec_id);
2931 $client->respond($response);
2937 # Start with a bib summary and augment the data with additional
2938 # metarecord content.
2939 sub get_one_metarecord_summary {
2940 my ($e, $rec_id) = @_;
2942 my $meta = $e->retrieve_metabib_metarecord($rec_id) or return {};
2943 my $maps = $e->search_metabib_metarecord_source_map({metarecord => $rec_id});
2945 my $bre_id = $meta->master_record;
2947 my $response = get_one_record_summary($e, $bre_id);
2949 $response->{metabib_id} = $rec_id;
2950 $response->{metabib_records} = [map {$_->source} @$maps];
2952 my @other_bibs = map {$_->source} grep {$_->source != $bre_id} @$maps;
2954 # Augment the record attributes with those of all of the records
2955 # linked to this metarecord.
2957 my $attrs = $e->search_metabib_record_attr_flat({id => \@other_bibs});
2959 my $attributes = $response->{attributes};
2961 for my $attr (@$attrs) {
2962 $attributes->{$attr->attr} = [] unless $attributes->{$attr->attr};
2963 push(@{$attributes->{$attr->attr}}, $attr->value) # avoid dupes
2964 unless grep {$_ eq $attr->value} @{$attributes->{$attr->attr}};
2971 sub get_one_record_summary {
2972 my ($e, $rec_id) = @_;
2974 my $bre = $e->retrieve_biblio_record_entry([$rec_id, {
2977 bre => [qw/compressed_display_entries mattrs creator editor/]
2981 # Compressed display fields are pachaged as JSON
2983 $display->{$_->name} = OpenSRF::Utils::JSON->JSON2perl($_->value)
2984 foreach @{$bre->compressed_display_entries};
2986 # Create an object of 'mraf' attributes.
2987 # Any attribute can be multi so dedupe and array-ify all of them.
2988 my $attributes = {};
2989 for my $attr (@{$bre->mattrs}) {
2990 $attributes->{$attr->attr} = {} unless $attributes->{$attr->attr};
2991 $attributes->{$attr->attr}->{$attr->value} = 1; # avoid dupes
2993 $attributes->{$_} = [keys %{$attributes->{$_}}] for keys %$attributes;
2998 $bre->clear_compressed_display_entries;
3003 display => $display,
3004 attributes => $attributes