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, $phys_loc) = @_;
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, $phys_loc);
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, $phys_loc) = @_;
1135 $phys_loc ||= $U->get_org_tree->id;
1137 my $IAmMetabib = ($self->api_name =~ /metabib/) ? 1 : 0;
1139 my $method = $IAmMetabib?
1140 'open-ils.storage.metabib.multiclass.staged.search_fts':
1141 'open-ils.storage.biblio.multiclass.staged.search_fts';
1143 $method .= '.staff' if $self->api_name =~ /staff$/;
1144 $method .= '.atomic';
1146 if (!$search_hash->{query}) {
1147 return {count => 0} unless (
1149 $search_hash->{searches} and
1150 scalar( keys %{$search_hash->{searches}} ));
1153 my $search_duration;
1154 my $user_offset = $search_hash->{offset} || 0; # user-specified offset
1155 my $user_limit = $search_hash->{limit} || 10;
1156 my $ignore_facet_classes = $search_hash->{ignore_facet_classes};
1157 $user_offset = ($user_offset >= 0) ? $user_offset : 0;
1158 $user_limit = ($user_limit >= 0) ? $user_limit : 10;
1161 # we're grabbing results on a per-superpage basis, which means the
1162 # limit and offset should coincide with superpage boundaries
1163 $search_hash->{offset} = 0;
1164 $search_hash->{limit} = $superpage_size;
1166 # force a well-known check_limit
1167 $search_hash->{check_limit} = $superpage_size;
1168 # restrict total tested to superpage size * number of superpages
1169 $search_hash->{core_limit} = $superpage_size * $max_superpages;
1171 # Set the configured estimation strategy, defaults to 'inclusion'.
1172 unless ($estimation_strategy) {
1173 $estimation_strategy = OpenSRF::Utils::SettingsClient
1176 apps => 'open-ils.search', app_settings => 'estimation_strategy'
1179 $search_hash->{estimation_strategy} = $estimation_strategy;
1181 # pull any existing results from the cache
1182 my $key = search_cache_key($method, $search_hash);
1183 my $facet_key = $key.'_facets';
1184 my $cache_data = $cache->get_cache($key) || {};
1186 # First, we want to make sure that someone else isn't currently trying to perform exactly
1187 # this same search. The point is to allow just one instance of a search to fill the needs
1188 # of all concurrent, identical searches. This will avoid spammy searches killing the
1189 # database without requiring admins to start locking some IP addresses out entirely.
1191 # There's still a tiny race condition where 2 might run, but without sigificantly more code
1192 # and complexity, this is close to the best we can do.
1194 if ($cache_data->{running}) { # someone is already doing the search...
1195 my $stop_looping = time() + $cache_timeout;
1196 while ( sleep(1) and time() < $stop_looping ) { # sleep for a second ... maybe they'll finish
1197 $cache_data = $cache->get_cache($key) || {};
1198 last if (!$cache_data->{running});
1200 } elsif (!$cache_data->{0}) { # we're the first ... let's give it a try
1201 $cache->put_cache($key, { running => $$ }, $cache_timeout / 3);
1204 # keep retrieving results until we find enough to
1205 # fulfill the user-specified limit and offset
1206 my $all_results = [];
1207 my $page; # current superpage
1208 my $current_page_summary = {};
1209 my $global_summary = {checked => 0, visible => 0, excluded => 0, deleted => 0, total => 0};
1212 for($page = 0; $page < $max_superpages; $page++) {
1214 my $data = $cache_data->{$page};
1218 $logger->debug("staged search: analyzing superpage $page");
1221 # this window of results is already cached
1222 $logger->debug("staged search: found cached results");
1223 $summary = $data->{summary};
1224 $results = $data->{results};
1227 # retrieve the window of results from the database
1228 $logger->debug("staged search: fetching results from the database");
1229 $search_hash->{skip_check} = $page * $superpage_size;
1230 $search_hash->{return_query} = $page == 0 ? 1 : 0;
1233 $results = $U->storagereq($method, %$search_hash);
1234 $search_duration = time - $start;
1235 $summary = shift(@$results) if $results;
1238 $logger->info("search timed out: duration=$search_duration: params=".
1239 OpenSRF::Utils::JSON->perl2JSON($search_hash));
1240 return {count => 0};
1243 $logger->info("staged search: DB call took $search_duration seconds and returned ".scalar(@$results)." rows, including summary");
1245 # Create backwards-compatible result structures
1247 $results = [map {[$_->{id}, $_->{badges}, $_->{popularity}, $_->{rel}, $_->{record}]} @$results];
1249 $results = [map {[$_->{id}, $_->{badges}, $_->{popularity}]} @$results];
1252 push @$new_ids, grep {defined($_)} map {$_->[0]} @$results;
1253 $results = [grep {defined $_->[0]} @$results];
1254 cache_staged_search_page($key, $page, $summary, $results) if $docache;
1257 tag_circulated_records($search_hash->{authtoken}, $results, $IAmMetabib)
1258 if $search_hash->{tag_circulated_records} and $search_hash->{authtoken};
1260 $current_page_summary = $summary;
1262 # add the new set of results to the set under construction
1263 push(@$all_results, @$results);
1265 my $current_count = scalar(@$all_results);
1267 if ($page == 0) { # all summaries are the same, just get the first
1268 for (keys %$summary) {
1269 $global_summary->{$_} = $summary->{$_};
1273 # we've found all the possible hits
1274 last if $current_count == $summary->{visible};
1276 # we've found enough results to satisfy the requested limit/offset
1277 last if $current_count >= ($user_limit + $user_offset);
1279 # we've scanned all possible hits
1280 last if($summary->{checked} < $superpage_size);
1283 # Let other backends grab our data now that we're done.
1284 $cache_data = $cache->get_cache($key);
1285 if ($$cache_data{running} and $$cache_data{running} == $$) {
1286 delete $$cache_data{running};
1287 $cache->put_cache($key, $cache_data, $cache_timeout);
1290 my $setting_names = [ qw/
1291 opac.did_you_mean.max_suggestions
1292 opac.did_you_mean.low_result_threshold
1293 search.symspell.min_suggestion_use_threshold
1294 search.symspell.soundex.weight
1295 search.symspell.pg_trgm.weight
1296 search.symspell.keyboard_distance.weight/ ];
1297 my %suggest_settings = $U->ou_ancestor_setting_batch_insecure(
1298 $phys_loc, $setting_names
1302 $suggest_settings{$_} ||= {value=>undef} for @$setting_names;
1304 # Pull this one off the front, it's not used for the function call
1305 my $max_suggestions_setting = shift @$setting_names;
1306 my $sugg_low_thresh_setting = shift @$setting_names;
1307 $max_suggestions_setting = $suggest_settings{$max_suggestions_setting}{value} // -1;
1308 my $suggest_low_threshold = $suggest_settings{$sugg_low_thresh_setting}{value} || 0;
1310 if ($global_summary->{visible} <= $suggest_low_threshold and $max_suggestions_setting != 0) {
1311 # For now, we're doing one-class/one-term suggestions only
1312 my ($class, $term) = one_class_one_term($global_summary->{query_struct});
1313 if ($class && $term) { # check for suggestions!
1314 my $suggestion_verbosity = 4;
1315 if ($max_suggestions_setting == -1) { # special value that means "only best suggestion, and not always"
1316 $max_suggestions_setting = 1;
1317 $suggestion_verbosity = 0;
1320 my @settings_params = map { $suggest_settings{$_}{value} } @$setting_names;
1321 my $suggs = new_editor()->json_query({
1323 'search.symspell_lookup',
1325 $suggestion_verbosity,
1329 limit => $max_suggestions_setting
1331 if (@$suggs and $$suggs[0]{suggestion} ne $term) {
1332 $global_summary->{suggestions}{'one_class_one_term'} = {
1335 suggestions => $suggs
1341 my @results = grep {defined $_} @$all_results[$user_offset..($user_offset + $user_limit - 1)];
1343 $conn->respond_complete(
1345 global_summary => $global_summary,
1346 count => $global_summary->{visible},
1347 core_limit => $search_hash->{core_limit},
1349 superpage_size => $search_hash->{check_limit},
1350 superpage_summary => $current_page_summary,
1351 facet_key => $facet_key,
1356 $logger->info("Completed canonicalized search is: $$global_summary{canonicalized_query}");
1358 return cache_facets($facet_key, $new_ids, $IAmMetabib, $ignore_facet_classes) if $docache;
1361 sub one_class_one_term {
1362 my $qstruct = shift;
1363 my $node = $$qstruct{children};
1370 or @{$$node{'&'}} != 1
1371 or ($$node{'&'}[0]{fields} and @{$$node{'&'}[0]{fields}} > 0)
1374 $class ||= $$node{'&'}[0]{class};
1375 $term ||= $$node{'&'}[0]{content};
1379 $node = $$node{'&'}[0]{children};
1382 return ($class, $term);
1385 sub fetch_display_fields {
1388 my $highlight_map = shift;
1392 $conn->respond_complete;
1396 my $hl_map_string = "";
1397 if (ref($highlight_map) =~ /HASH/) {
1398 for my $tsq (keys %$highlight_map) {
1399 my $field_list = join(',', @{$$highlight_map{$tsq}});
1400 $hl_map_string .= ' || ' if $hl_map_string;
1401 $hl_map_string .= "hstore(($tsq)\:\:TEXT,'$field_list')";
1405 my $e = new_editor();
1407 for my $record ( @records ) {
1408 next unless ($record && $hl_map_string);
1411 {from => ['search.highlight_display_fields', $record, $hl_map_string]}
1418 __PACKAGE__->register_method(
1419 method => 'fetch_display_fields',
1420 api_name => 'open-ils.search.fetch.metabib.display_field.highlight',
1425 sub tag_circulated_records {
1426 my ($auth, $results, $metabib) = @_;
1427 my $e = new_editor(authtoken => $auth);
1428 return $results unless $e->checkauth;
1431 select => { acn => [{ column => 'record', alias => 'tagme' }] },
1432 from => { auch => { acp => { join => 'acn' }} },
1433 where => { usr => $e->requestor->id },
1439 select => { mmrsm => [{ column => 'metarecord', alias => 'tagme' }] },
1441 where => { source => { in => $query } },
1446 # Give me the distinct set of bib records that exist in the user's visible circulation history
1447 my $circ_recs = $e->json_query( $query );
1449 # if the record appears in the circ history, push a 1 onto
1450 # the rec array structure to indicate truthiness
1451 for my $rec (@$results) {
1452 push(@$rec, 1) if grep { $_->{tagme} eq $$rec[0] } @$circ_recs;
1458 # creates a unique token to represent the query in the cache
1459 sub search_cache_key {
1461 my $search_hash = shift;
1463 for my $key (sort keys %$search_hash) {
1464 push(@sorted, ($key => $$search_hash{$key}))
1465 unless $key eq 'limit' or
1467 $key eq 'skip_check';
1469 my $s = OpenSRF::Utils::JSON->perl2JSON(\@sorted);
1470 return $pfx . md5_hex($method . $s);
1473 sub retrieve_cached_facets {
1479 return undef unless ($key and $key =~ /_facets$/);
1482 local $SIG{ALRM} = sub {die};
1483 alarm(10); # we'll sleep for as much as 10s
1485 die if $cache->get_cache($key . '_COMPLETE');
1486 } while (sleep(0.05));
1491 my $blob = $cache->get_cache($key) || {};
1495 for my $f ( keys %$blob ) {
1496 my @sorted = map{ { $$_[1] => $$_[0] } } sort {$$b[0] <=> $$a[0] || $$a[1] cmp $$b[1]} map { [$$blob{$f}{$_}, $_] } keys %{ $$blob{$f} };
1497 @sorted = @sorted[0 .. $limit - 1] if (scalar(@sorted) > $limit);
1498 for my $s ( @sorted ) {
1499 my ($k) = keys(%$s);
1500 my ($v) = values(%$s);
1501 $$facets{$f}{$k} = $v;
1511 __PACKAGE__->register_method(
1512 method => "retrieve_cached_facets",
1513 api_name => "open-ils.search.facet_cache.retrieve",
1515 desc => 'Returns facet data derived from a specific search based on a key '.
1516 'generated by open-ils.search.biblio.multiclass.staged and friends.',
1519 desc => "The facet cache key returned with the initial search as the facet_key hash value",
1524 desc => 'Two level hash of facet values. Top level key is the facet id defined on the config.metabib_field table. '.
1525 'Second level key is a string facet value. Datum attached to each facet value is the number of distinct records, '.
1526 'or metarecords for a metarecord search, which use that facet value and are visible to the search at the time of '.
1527 'facet retrieval. These counts are calculated for all superpages that have been checked for visibility.',
1535 # add facets for this search to the facet cache
1536 my($key, $results, $metabib, $ignore) = @_;
1537 my $data = $cache->get_cache($key);
1540 return undef unless (@$results);
1542 my $facets_function = $metabib ? 'search.facets_for_metarecord_set'
1543 : 'search.facets_for_record_set';
1544 my $results_str = '{' . join(',', @$results) . '}';
1545 my $ignore_str = ref($ignore) ? '{' . join(',', @$ignore) . '}'
1548 from => [ $facets_function, $ignore_str, $results_str ]
1551 my $facets = OpenILS::Utils::CStoreEditor->new->json_query($query, {substream => 1});
1553 for my $facet (@$facets) {
1554 next unless ($facet->{value});
1555 $data->{$facet->{id}}->{$facet->{value}} += $facet->{count};
1558 $logger->info("facet compilation: cached with key=$key");
1560 $cache->put_cache($key, $data, $cache_timeout);
1561 $cache->put_cache($key.'_COMPLETE', 1, $cache_timeout);
1564 sub cache_staged_search_page {
1565 # puts this set of results into the cache
1566 my($key, $page, $summary, $results) = @_;
1567 my $data = $cache->get_cache($key);
1570 summary => $summary,
1574 $logger->info("staged search: cached with key=$key, superpage=$page, estimated=".
1575 ($summary->{estimated_hit_count} || "none") .
1576 ", visible=" . ($summary->{visible} || "none")
1579 $cache->put_cache($key, $data, $cache_timeout);
1587 my $start = $offset;
1588 my $end = $offset + $limit - 1;
1590 $logger->debug("searching cache for $key : $start..$end\n");
1592 return undef unless $cache;
1593 my $data = $cache->get_cache($key);
1595 return undef unless $data;
1597 my $count = $data->[0];
1600 return undef unless $offset < $count;
1603 for( my $i = $offset; $i <= $end; $i++ ) {
1604 last unless my $d = $$data[$i];
1605 push( @result, $d );
1608 $logger->debug("search_cache found ".scalar(@result)." items for count=$count, start=$start, end=$end");
1615 my( $key, $count, $data ) = @_;
1616 return undef unless $cache;
1617 $logger->debug("search_cache putting ".
1618 scalar(@$data)." items at key $key with timeout $cache_timeout");
1619 $cache->put_cache($key, [ $count, $data ], $cache_timeout);
1623 __PACKAGE__->register_method(
1624 method => "biblio_mrid_to_modsbatch_batch",
1625 api_name => "open-ils.search.biblio.metarecord.mods_slim.batch.retrieve"
1628 sub biblio_mrid_to_modsbatch_batch {
1629 my( $self, $client, $mrids) = @_;
1630 # warn "Performing mrid_to_modsbatch_batch..."; # unconditional warn
1632 my $method = $self->method_lookup("open-ils.search.biblio.metarecord.mods_slim.retrieve");
1633 for my $id (@$mrids) {
1634 next unless defined $id;
1635 my ($m) = $method->run($id);
1642 foreach (qw /open-ils.search.biblio.metarecord.mods_slim.retrieve
1643 open-ils.search.biblio.metarecord.mods_slim.retrieve.staff/)
1645 __PACKAGE__->register_method(
1646 method => "biblio_mrid_to_modsbatch",
1649 desc => "Returns the mvr associated with a given metarecod. If none exists, it is created. "
1650 . "As usual, the .staff version of this method will include otherwise hidden records.",
1652 { desc => 'Metarecord ID', type => 'number' },
1653 { desc => '(Optional) Search filters hash with possible keys: format, org, depth', type => 'object' }
1656 desc => 'MVR Object, event on error',
1662 sub biblio_mrid_to_modsbatch {
1663 my( $self, $client, $mrid, $args) = @_;
1665 # warn "Grabbing mvr for $mrid\n"; # unconditional warn
1667 my ($mr, $evt) = _grab_metarecord($mrid);
1668 return $evt unless $mr;
1670 my $mvr = biblio_mrid_check_mvr($self, $client, $mr) ||
1671 biblio_mrid_make_modsbatch($self, $client, $mr);
1673 return $mvr unless ref($args);
1675 # Here we find the lead record appropriate for the given filters
1676 # and use that for the title and author of the metarecord
1677 my $format = $$args{format};
1678 my $org = $$args{org};
1679 my $depth = $$args{depth};
1681 return $mvr unless $format or $org or $depth;
1683 my $method = "open-ils.storage.ordered.metabib.metarecord.records";
1684 $method = "$method.staff" if $self->api_name =~ /staff/o;
1686 my $rec = $U->storagereq($method, $format, $org, $depth, 1);
1688 if( my $mods = $U->record_to_mvr($rec) ) {
1690 $mvr->title( $mods->title );
1691 $mvr->author($mods->author);
1692 $logger->debug("mods_slim updating title and ".
1693 "author in mvr with ".$mods->title." : ".$mods->author);
1699 # converts a metarecord to an mvr
1702 my $perl = OpenSRF::Utils::JSON->JSON2perl($mr->mods());
1703 return Fieldmapper::metabib::virtual_record->new($perl);
1706 # checks to see if a metarecord has mods, if so returns true;
1708 __PACKAGE__->register_method(
1709 method => "biblio_mrid_check_mvr",
1710 api_name => "open-ils.search.biblio.metarecord.mods_slim.check",
1711 notes => "Takes a metarecord ID or a metarecord object and returns true "
1712 . "if the metarecord already has an mvr associated with it."
1715 sub biblio_mrid_check_mvr {
1716 my( $self, $client, $mrid ) = @_;
1720 if(ref($mrid)) { $mr = $mrid; }
1721 else { ($mr, $evt) = _grab_metarecord($mrid); }
1722 return $evt if $evt;
1724 # warn "Checking mvr for mr " . $mr->id . "\n"; # unconditional warn
1726 return _mr_to_mvr($mr) if $mr->mods();
1730 sub _grab_metarecord {
1732 my $e = new_editor();
1733 my $mr = $e->retrieve_metabib_metarecord($mrid) or return ( undef, $e->event );
1738 __PACKAGE__->register_method(
1739 method => "biblio_mrid_make_modsbatch",
1740 api_name => "open-ils.search.biblio.metarecord.mods_slim.create",
1741 notes => "Takes either a metarecord ID or a metarecord object. "
1742 . "Forces the creations of an mvr for the given metarecord. "
1743 . "The created mvr is returned."
1746 sub biblio_mrid_make_modsbatch {
1747 my( $self, $client, $mrid ) = @_;
1749 my $e = new_editor();
1756 $mr = $e->retrieve_metabib_metarecord($mrid)
1757 or return $e->event;
1760 my $masterid = $mr->master_record;
1761 $logger->info("creating new mods batch for metarecord=$mrid, master record=$masterid");
1763 my $ids = $U->storagereq(
1764 'open-ils.storage.ordered.metabib.metarecord.records.staff.atomic', $mrid);
1765 return undef unless @$ids;
1767 my $master = $e->retrieve_biblio_record_entry($masterid)
1768 or return $e->event;
1770 # start the mods batch
1771 my $u = OpenILS::Utils::ModsParser->new();
1772 $u->start_mods_batch( $master->marc );
1774 # grab all of the sub-records and shove them into the batch
1775 my @ids = grep { $_ ne $masterid } @$ids;
1776 #my $subrecs = (@ids) ? $e->batch_retrieve_biblio_record_entry(\@ids) : [];
1781 my $r = $e->retrieve_biblio_record_entry($i);
1782 push( @$subrecs, $r ) if $r;
1787 $logger->debug("adding record ".$_->id." to mods batch for metarecord=$mrid");
1788 $u->push_mods_batch( $_->marc ) if $_->marc;
1792 # finish up and send to the client
1793 my $mods = $u->finish_mods_batch();
1794 $mods->doc_id($mrid);
1795 $client->respond_complete($mods);
1798 # now update the mods string in the db
1799 my $string = OpenSRF::Utils::JSON->perl2JSON($mods->decast);
1802 $e = new_editor(xact => 1);
1803 $e->update_metabib_metarecord($mr)
1804 or $logger->error("Error setting mods text on metarecord $mrid : " . Dumper($e->event));
1811 # converts a mr id into a list of record ids
1813 foreach (qw/open-ils.search.biblio.metarecord_to_records
1814 open-ils.search.biblio.metarecord_to_records.staff/)
1816 __PACKAGE__->register_method(
1817 method => "biblio_mrid_to_record_ids",
1820 desc => "Fetch record IDs corresponding to a meta-record ID, with optional search filters. "
1821 . "As usual, the .staff version of this method will include otherwise hidden records.",
1823 { desc => 'Metarecord ID', type => 'number' },
1824 { desc => '(Optional) Search filters hash with possible keys: format, org, depth', type => 'object' }
1827 desc => 'Results object like {count => $i, ids =>[...]}',
1835 sub biblio_mrid_to_record_ids {
1836 my( $self, $client, $mrid, $args ) = @_;
1838 my $format = $$args{format};
1839 my $org = $$args{org};
1840 my $depth = $$args{depth};
1842 my $method = "open-ils.storage.ordered.metabib.metarecord.records.atomic";
1843 $method =~ s/atomic/staff\.atomic/o if $self->api_name =~ /staff/o;
1844 my $recs = $U->storagereq($method, $mrid, $format, $org, $depth);
1846 return { count => scalar(@$recs), ids => $recs };
1850 __PACKAGE__->register_method(
1851 method => "biblio_record_to_marc_html",
1852 api_name => "open-ils.search.biblio.record.html"
1855 __PACKAGE__->register_method(
1856 method => "biblio_record_to_marc_html",
1857 api_name => "open-ils.search.authority.to_html"
1860 # Persistent parsers and setting objects
1861 my $parser = XML::LibXML->new();
1862 my $xslt = XML::LibXSLT->new();
1864 my $slim_marc_sheet;
1865 my $settings_client = OpenSRF::Utils::SettingsClient->new();
1867 sub biblio_record_to_marc_html {
1868 my($self, $client, $recordid, $slim, $marcxml) = @_;
1871 my $dir = $settings_client->config_value("dirs", "xsl");
1874 unless($slim_marc_sheet) {
1875 my $xsl = $settings_client->config_value(
1876 "apps", "open-ils.search", "app_settings", 'marc_html_xsl_slim');
1878 $xsl = $parser->parse_file("$dir/$xsl");
1879 $slim_marc_sheet = $xslt->parse_stylesheet($xsl);
1882 $sheet = $slim_marc_sheet;
1886 unless($marc_sheet) {
1887 my $xsl_key = ($slim) ? 'marc_html_xsl_slim' : 'marc_html_xsl';
1888 my $xsl = $settings_client->config_value(
1889 "apps", "open-ils.search", "app_settings", 'marc_html_xsl');
1890 $xsl = $parser->parse_file("$dir/$xsl");
1891 $marc_sheet = $xslt->parse_stylesheet($xsl);
1893 $sheet = $marc_sheet;
1898 my $e = new_editor();
1899 if($self->api_name =~ /authority/) {
1900 $record = $e->retrieve_authority_record_entry($recordid)
1901 or return $e->event;
1903 $record = $e->retrieve_biblio_record_entry($recordid)
1904 or return $e->event;
1906 $marcxml = $record->marc;
1909 my $xmldoc = $parser->parse_string($marcxml);
1910 my $html = $sheet->transform($xmldoc);
1911 return $html->documentElement->toString();
1914 __PACKAGE__->register_method(
1915 method => "send_event_email_output",
1916 api_name => "open-ils.search.biblio.record.email.send_output",
1918 sub send_event_email_output {
1919 my($self, $client, $auth, $event_id, $capkey, $capanswer) = @_;
1920 return undef unless $event_id;
1922 my $captcha_pass = 0;
1925 $real_answer = $cache->get_cache(md5_hex($capkey));
1926 $captcha_pass++ if ($real_answer eq $capanswer);
1929 my $e = new_editor(authtoken => $auth);
1930 return $e->die_event unless $captcha_pass || $e->checkauth;
1932 my $event = $e->retrieve_action_trigger_event([$event_id,{flesh => 1, flesh_fields => { atev => ['template_output']}}]);
1933 return undef unless ($event and $event->template_output);
1935 my $smtp = OpenSRF::Utils::SettingsClient
1937 ->config_value('email_notify', 'smtp_server');
1939 my $sender = Email::Send->new({mailer => 'SMTP'});
1940 $sender->mailer_args([Host => $smtp]);
1945 my $email = Email::Simple->new($event->template_output->data);
1947 for my $hfield (qw/From To Subject Bcc Cc Reply-To Sender/) {
1948 my @headers = $email->header($hfield);
1949 $email->header_set($hfield => map { encode("MIME-Header", $_) } @headers) if ($headers[0]);
1952 $email->header_set('MIME-Version' => '1.0');
1953 $email->header_set('Content-Type' => "text/plain; charset=UTF-8");
1954 $email->header_set('Content-Transfer-Encoding' => '8bit');
1957 $stat = $sender->send($email);
1958 } catch Error with {
1959 $err = $stat = shift;
1960 $logger->error("send_event_email_output: Email failed with error: $err");
1963 if( !$err and $stat and $stat->type eq 'success' ) {
1964 $logger->info("send_event_email_output: successfully sent email");
1967 $logger->warn("send_event_email_output: unable to send email: ".Dumper($stat));
1972 __PACKAGE__->register_method(
1973 method => "format_biblio_record_entry",
1974 api_name => "open-ils.search.biblio.record.print.preview",
1977 __PACKAGE__->register_method(
1978 method => "format_biblio_record_entry",
1979 api_name => "open-ils.search.biblio.record.email.preview",
1982 __PACKAGE__->register_method(
1983 method => "format_biblio_record_entry",
1984 api_name => "open-ils.search.biblio.record.print",
1986 desc => 'Returns a printable version of the specified bib record',
1988 { desc => 'Biblio record entry ID or array of IDs', type => 'number' },
1989 { desc => 'Context library for holdings, if applicable', type => 'number' },
1990 { desc => 'Sort order, if applicable', type => 'string' },
1991 { desc => 'Sort direction, if applicable', type => 'string' },
1992 { desc => 'Definition Group Member id', type => 'number' },
1995 desc => q/An action_trigger.event object or error event./,
2000 __PACKAGE__->register_method(
2001 method => "format_biblio_record_entry",
2002 api_name => "open-ils.search.biblio.record.email",
2004 desc => 'Emails an A/T templated version of the specified bib records to the authorized user',
2006 { desc => 'Authentication token', type => 'string'},
2007 { desc => 'Biblio record entry ID or array of IDs', type => 'number' },
2008 { desc => 'Context library for holdings, if applicable', type => 'number' },
2009 { desc => 'Sort order, if applicable', type => 'string' },
2010 { desc => 'Sort direction, if applicable', type => 'string' },
2011 { desc => 'Definition Group Member id', type => 'number' },
2012 { desc => 'Whether to bypass auth due to captcha', type => 'bool' },
2013 { desc => 'Email address, if none for the user', type => 'string' },
2014 { desc => 'Subject, if customized', type => 'string' },
2017 desc => q/Undefined on success, otherwise an error event./,
2023 sub format_biblio_record_entry {
2024 my ($self, $conn) = splice @_, 0, 2;
2026 my $for_print = ($self->api_name =~ /print/);
2027 my $for_email = ($self->api_name =~ /email/);
2028 my $preview = ($self->api_name =~ /preview/);
2030 my ($auth, $captcha_pass, $email, $subject);
2033 ($captcha_pass, $email, $subject) = splice @_, -3, 3;
2035 my ($bib_id, $holdings_context_org, $bib_sort, $sort_dir, $group_member) = @_;
2036 $holdings_context_org ||= $U->get_org_tree->id;
2037 $bib_sort ||= 'author';
2038 $sort_dir ||= 'ascending';
2040 my $e; my $event_context_org; my $type = 'brief';
2043 $event_context_org = $holdings_context_org;
2044 $e = new_editor(xact => 1);
2045 } elsif ($for_email) {
2046 $e = new_editor(authtoken => $auth, xact => 1);
2047 return $e->die_event unless $captcha_pass || $e->checkauth;
2048 $event_context_org = $e->requestor ? $e->requestor->home_ou : $holdings_context_org;
2049 $email ||= $e->requestor ? $e->requestor->email : '';
2052 if ($group_member) {
2053 $group_member = $e->retrieve_action_trigger_event_def_group_member($group_member);
2054 if ($group_member and $U->is_true($group_member->holdings)) {
2059 $holdings_context_org = $e->retrieve_actor_org_unit($holdings_context_org);
2062 if (ref $bib_id ne 'ARRAY') {
2063 $bib_ids = [ $bib_id ];
2068 my $bucket = Fieldmapper::container::biblio_record_entry_bucket->new;
2069 $bucket->btype('temp');
2070 $bucket->name('format_biblio_record_entry ' . $U->create_uuid_string);
2072 $bucket->owner($e->requestor || 1)
2076 my $bucket_obj = $e->create_container_biblio_record_entry_bucket($bucket);
2078 for my $id (@$bib_ids) {
2080 my $bib = $e->retrieve_biblio_record_entry([$id]) or return $e->die_event;
2082 my $bucket_entry = Fieldmapper::container::biblio_record_entry_bucket_item->new;
2083 $bucket_entry->target_biblio_record_entry($bib);
2084 $bucket_entry->bucket($bucket_obj->id);
2085 $e->create_container_biblio_record_entry_bucket_item($bucket_entry);
2093 subject => $subject,
2094 context_org => $holdings_context_org->shortname,
2095 sort_by => $bib_sort,
2096 sort_dir => $sort_dir,
2102 return $U->fire_object_event(undef, 'biblio.format.record_entry.print', [ $bucket ], $event_context_org, undef, [ $usr_data ]);
2104 } elsif ($for_email) {
2106 return $U->fire_object_event(undef, 'biblio.format.record_entry.email', [ $bucket ], $event_context_org, undef, [ $usr_data ])
2109 $U->create_events_for_hook('biblio.format.record_entry.email', $bucket, $event_context_org, undef, $usr_data, 1);
2116 __PACKAGE__->register_method(
2117 method => "retrieve_all_copy_statuses",
2118 api_name => "open-ils.search.config.copy_status.retrieve.all"
2121 sub retrieve_all_copy_statuses {
2122 my( $self, $client ) = @_;
2123 return new_editor()->retrieve_all_config_copy_status();
2127 __PACKAGE__->register_method(
2128 method => "copy_counts_per_org",
2129 api_name => "open-ils.search.biblio.copy_counts.retrieve"
2132 __PACKAGE__->register_method(
2133 method => "copy_counts_per_org",
2134 api_name => "open-ils.search.biblio.copy_counts.retrieve.staff"
2137 sub copy_counts_per_org {
2138 my( $self, $client, $record_id ) = @_;
2140 warn "Retreiveing copy copy counts for record $record_id and method " . $self->api_name . "\n";
2142 my $method = "open-ils.storage.biblio.record_entry.global_copy_count.atomic";
2143 if($self->api_name =~ /staff/) { $method =~ s/atomic/staff\.atomic/; }
2145 my $counts = $apputils->simple_scalar_request(
2146 "open-ils.storage", $method, $record_id );
2148 $counts = [ sort {$a->[0] <=> $b->[0]} @$counts ];
2153 __PACKAGE__->register_method(
2154 method => "copy_count_summary",
2155 api_name => "open-ils.search.biblio.copy_counts.summary.retrieve",
2156 notes => "returns an array of these: "
2157 . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, <status1_count>, <status2_count>,...] "
2158 . "where statusx is a copy status name. The statuses are sorted by ID.",
2162 sub copy_count_summary {
2163 my( $self, $client, $rid, $org, $depth ) = @_;
2166 my $data = $U->storagereq(
2167 'open-ils.storage.biblio.record_entry.status_copy_count.atomic', $rid, $org, $depth );
2170 (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2172 (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2176 __PACKAGE__->register_method(
2177 method => "copy_location_count_summary",
2178 api_name => "open-ils.search.biblio.copy_location_counts.summary.retrieve",
2179 notes => "returns an array of these: "
2180 . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, copy_location, <status1_count>, <status2_count>,...] "
2181 . "where statusx is a copy status name. The statuses are sorted by ID.",
2184 sub copy_location_count_summary {
2185 my( $self, $client, $rid, $org, $depth ) = @_;
2188 my $data = $U->storagereq(
2189 'open-ils.storage.biblio.record_entry.status_copy_location_count.atomic', $rid, $org, $depth );
2192 (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2194 (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2196 || $a->[4] cmp $b->[4]
2200 __PACKAGE__->register_method(
2201 method => "copy_count_location_summary",
2202 api_name => "open-ils.search.biblio.copy_counts.location.summary.retrieve",
2203 notes => "returns an array of these: "
2204 . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, <status1_count>, <status2_count>,...] "
2205 . "where statusx is a copy status name. The statuses are sorted by ID."
2208 sub copy_count_location_summary {
2209 my( $self, $client, $rid, $org, $depth ) = @_;
2212 my $data = $U->storagereq(
2213 'open-ils.storage.biblio.record_entry.status_copy_location_count.atomic', $rid, $org, $depth );
2215 (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2217 (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2222 foreach (qw/open-ils.search.biblio.marc
2223 open-ils.search.biblio.marc.staff/)
2225 __PACKAGE__->register_method(
2226 method => "marc_search",
2229 desc => 'Fetch biblio IDs based on MARC record criteria. '
2230 . 'As usual, the .staff version of the search includes otherwise hidden records',
2233 desc => 'Search hash (required) with possible elements: searches, limit, offset, sort, sort_dir. ' .
2234 'See perldoc ' . __PACKAGE__ . ' for more detail.',
2237 {desc => 'timeout (optional)', type => 'number'}
2240 desc => 'Results object like: { "count": $i, "ids": [...] }',
2247 =head3 open-ils.search.biblio.marc (arghash, timeout)
2249 As elsewhere the arghash is the required argument, and must be a hashref. The keys are:
2251 searches: complex query object (required)
2252 org_unit: The org ID to focus the search at
2253 depth : The org depth
2254 limit : integer search limit default: 10
2255 offset : integer search offset default: 0
2256 sort : What field to sort the results on? [ author | title | pubdate ]
2257 sort_dir: In what direction do we sort? [ asc | desc ]
2259 Additional keys to refine search criteria:
2262 language : Language (code)
2263 lit_form : Literary form
2264 item_form: Item form
2265 item_type: Item type
2266 format : The MARC format
2268 Please note that the specific strings to be used in the "addtional keys" will be entirely
2269 dependent on your loaded data.
2271 All keys except "searches" are optional.
2272 The "searches" value must be an arrayref of hashref elements, including keys "term" and "restrict".
2274 For example, an arg hash might look like:
2296 The arghash is eventually passed to the SRF call:
2297 L<open-ils.storage.biblio.full_rec.multi_search[.staff].atomic>
2299 Presently, search uses the cache unconditionally.
2303 # FIXME: that example above isn't actually tested.
2304 # FIXME: sort and limit added. item_type not tested yet.
2305 # TODO: docache option?
2307 my( $self, $conn, $args, $timeout ) = @_;
2309 my $method = 'open-ils.storage.biblio.full_rec.multi_search';
2310 $method .= ".staff" if $self->api_name =~ /staff/;
2311 $method .= ".atomic";
2313 my $limit = $args->{limit} || 10;
2314 my $offset = $args->{offset} || 0;
2316 # allow caller to pass in a call timeout since MARC searches
2317 # can take longer than the default 60-second timeout.
2318 # Default to 2 mins. Arbitrarily cap at 5 mins.
2319 $timeout = 120 if !$timeout or $timeout > 300;
2322 push( @search, ($_ => $$args{$_}) ) for (sort keys %$args);
2323 my $ckey = $pfx . md5_hex($method . OpenSRF::Utils::JSON->perl2JSON(\@search));
2325 my $recs = search_cache($ckey, $offset, $limit);
2329 my $ses = OpenSRF::AppSession->create('open-ils.storage');
2330 my $req = $ses->request($method, %$args);
2331 my $resp = $req->recv($timeout);
2333 if($resp and $recs = $resp->content) {
2334 put_cache($ckey, scalar(@$recs), $recs);
2343 $count = $recs->[0]->[2] if $recs->[0] and $recs->[0]->[2];
2344 my @recs = map { $_->[0] } @$recs;
2346 return { ids => \@recs, count => $count };
2350 foreach my $isbn_method (qw/
2351 open-ils.search.biblio.isbn
2352 open-ils.search.biblio.isbn.staff
2354 __PACKAGE__->register_method(
2355 method => "biblio_search_isbn",
2356 api_name => $isbn_method,
2358 desc => 'Retrieve biblio IDs for a given ISBN. The .staff version of the call includes otherwise hidden hits.',
2360 {desc => 'ISBN', type => 'string'}
2363 desc => 'Results object like: { "count": $i, "ids": [...] }',
2370 sub biblio_search_isbn {
2371 my( $self, $client, $isbn ) = @_;
2372 $logger->debug("Searching ISBN $isbn");
2373 # the previous implementation of this method was essentially unlimited,
2374 # so we will set our limit very high and let multiclass.query provide any
2376 # XXX: if making this unlimited is deemed important, we might consider
2377 # reworking 'open-ils.storage.id_list.biblio.record_entry.search.isbn',
2378 # which is functionally deprecated at this point, or a custom call to
2379 # 'open-ils.storage.biblio.multiclass.search_fts'
2381 my $isbn_method = 'open-ils.search.biblio.multiclass.query';
2382 if ($self->api_name =~ m/.staff$/) {
2383 $isbn_method .= '.staff';
2386 my $method = $self->method_lookup($isbn_method);
2387 my ($search_result) = $method->run({'limit' => 1000000}, "identifier|isbn:$isbn");
2388 my @recs = map { $_->[0] } @{$search_result->{'ids'}};
2389 return { ids => \@recs, count => $search_result->{'count'} };
2392 __PACKAGE__->register_method(
2393 method => "biblio_search_isbn_batch",
2394 api_name => "open-ils.search.biblio.isbn_list",
2397 # XXX: see biblio_search_isbn() for note concerning 'limit'
2398 sub biblio_search_isbn_batch {
2399 my( $self, $client, $isbn_list ) = @_;
2400 $logger->debug("Searching ISBNs @$isbn_list");
2401 my @recs = (); my %rec_set = ();
2402 my $method = $self->method_lookup('open-ils.search.biblio.multiclass.query');
2403 foreach my $isbn ( @$isbn_list ) {
2404 my ($search_result) = $method->run({'limit' => 1000000}, "identifier|isbn:$isbn");
2405 my @recs_subset = map { $_->[0] } @{$search_result->{'ids'}};
2406 foreach my $rec (@recs_subset) {
2407 if (! $rec_set{ $rec }) {
2408 $rec_set{ $rec } = 1;
2413 return { ids => \@recs, count => scalar(@recs) };
2416 foreach my $issn_method (qw/
2417 open-ils.search.biblio.issn
2418 open-ils.search.biblio.issn.staff
2420 __PACKAGE__->register_method(
2421 method => "biblio_search_issn",
2422 api_name => $issn_method,
2424 desc => 'Retrieve biblio IDs for a given ISSN',
2426 {desc => 'ISBN', type => 'string'}
2429 desc => 'Results object like: { "count": $i, "ids": [...] }',
2436 sub biblio_search_issn {
2437 my( $self, $client, $issn ) = @_;
2438 $logger->debug("Searching ISSN $issn");
2439 # the previous implementation of this method was essentially unlimited,
2440 # so we will set our limit very high and let multiclass.query provide any
2442 # XXX: if making this unlimited is deemed important, we might consider
2443 # reworking 'open-ils.storage.id_list.biblio.record_entry.search.issn',
2444 # which is functionally deprecated at this point, or a custom call to
2445 # 'open-ils.storage.biblio.multiclass.search_fts'
2447 my $issn_method = 'open-ils.search.biblio.multiclass.query';
2448 if ($self->api_name =~ m/.staff$/) {
2449 $issn_method .= '.staff';
2452 my $method = $self->method_lookup($issn_method);
2453 my ($search_result) = $method->run({'limit' => 1000000}, "identifier|issn:$issn");
2454 my @recs = map { $_->[0] } @{$search_result->{'ids'}};
2455 return { ids => \@recs, count => $search_result->{'count'} };
2459 __PACKAGE__->register_method(
2460 method => "fetch_mods_by_copy",
2461 api_name => "open-ils.search.biblio.mods_from_copy",
2464 desc => 'Retrieve MODS record given an attached copy ID',
2466 { desc => 'Copy ID', type => 'number' }
2469 desc => 'MODS record, event on error or uncataloged item'
2474 sub fetch_mods_by_copy {
2475 my( $self, $client, $copyid ) = @_;
2476 my ($record, $evt) = $apputils->fetch_record_by_copy( $copyid );
2477 return $evt if $evt;
2478 return OpenILS::Event->new('ITEM_NOT_CATALOGED') unless $record->marc;
2479 return $apputils->record_to_mvr($record);
2483 # -------------------------------------------------------------------------------------
2485 __PACKAGE__->register_method(
2486 method => "cn_browse",
2487 api_name => "open-ils.search.callnumber.browse.target",
2488 notes => "Starts a callnumber browse"
2491 __PACKAGE__->register_method(
2492 method => "cn_browse",
2493 api_name => "open-ils.search.callnumber.browse.page_up",
2494 notes => "Returns the previous page of callnumbers",
2497 __PACKAGE__->register_method(
2498 method => "cn_browse",
2499 api_name => "open-ils.search.callnumber.browse.page_down",
2500 notes => "Returns the next page of callnumbers",
2504 # RETURNS array of arrays like so: label, owning_lib, record, id
2506 my( $self, $client, @params ) = @_;
2509 $method = 'open-ils.storage.asset.call_number.browse.target.atomic'
2510 if( $self->api_name =~ /target/ );
2511 $method = 'open-ils.storage.asset.call_number.browse.page_up.atomic'
2512 if( $self->api_name =~ /page_up/ );
2513 $method = 'open-ils.storage.asset.call_number.browse.page_down.atomic'
2514 if( $self->api_name =~ /page_down/ );
2516 return $apputils->simplereq( 'open-ils.storage', $method, @params );
2518 # -------------------------------------------------------------------------------------
2520 __PACKAGE__->register_method(
2521 method => "fetch_cn",
2522 api_name => "open-ils.search.callnumber.retrieve",
2524 notes => "retrieves a callnumber based on ID",
2528 my( $self, $client, $id ) = @_;
2530 my $e = new_editor();
2531 my( $cn, $evt ) = $apputils->fetch_callnumber( $id, 0, $e );
2532 return $evt if $evt;
2536 __PACKAGE__->register_method(
2537 method => "fetch_fleshed_cn",
2538 api_name => "open-ils.search.callnumber.fleshed.retrieve",
2540 notes => "retrieves a callnumber based on ID, fleshing prefix, suffix, and label_class",
2543 sub fetch_fleshed_cn {
2544 my( $self, $client, $id ) = @_;
2546 my $e = new_editor();
2547 my( $cn, $evt ) = $apputils->fetch_callnumber( $id, 1, $e );
2548 return $evt if $evt;
2553 __PACKAGE__->register_method(
2554 method => "fetch_copy_by_cn",
2555 api_name => 'open-ils.search.copies_by_call_number.retrieve',
2557 Returns an array of copy ID's by callnumber ID
2558 @param cnid The callnumber ID
2559 @return An array of copy IDs
2563 sub fetch_copy_by_cn {
2564 my( $self, $conn, $cnid ) = @_;
2565 return $U->cstorereq(
2566 'open-ils.cstore.direct.asset.copy.id_list.atomic',
2567 { call_number => $cnid, deleted => 'f' } );
2570 __PACKAGE__->register_method(
2571 method => 'fetch_cn_by_info',
2572 api_name => 'open-ils.search.call_number.retrieve_by_info',
2574 @param label The callnumber label
2575 @param record The record the cn is attached to
2576 @param org The owning library of the cn
2577 @return The callnumber object
2582 sub fetch_cn_by_info {
2583 my( $self, $conn, $label, $record, $org ) = @_;
2584 return $U->cstorereq(
2585 'open-ils.cstore.direct.asset.call_number.search',
2586 { label => $label, record => $record, owning_lib => $org, deleted => 'f' });
2591 __PACKAGE__->register_method(
2592 method => 'bib_extras',
2593 api_name => 'open-ils.search.biblio.lit_form_map.retrieve.all',
2596 __PACKAGE__->register_method(
2597 method => 'bib_extras',
2598 api_name => 'open-ils.search.biblio.item_form_map.retrieve.all',
2599 ctype => 'item_form'
2601 __PACKAGE__->register_method(
2602 method => 'bib_extras',
2603 api_name => 'open-ils.search.biblio.item_type_map.retrieve.all',
2604 ctype => 'item_type',
2606 __PACKAGE__->register_method(
2607 method => 'bib_extras',
2608 api_name => 'open-ils.search.biblio.bib_level_map.retrieve.all',
2609 ctype => 'bib_level'
2611 __PACKAGE__->register_method(
2612 method => 'bib_extras',
2613 api_name => 'open-ils.search.biblio.audience_map.retrieve.all',
2619 $logger->warn("deprecation warning: " .$self->api_name);
2621 my $e = new_editor();
2623 my $ctype = $self->{ctype};
2624 my $ccvms = $e->search_config_coded_value_map({ctype => $ctype});
2627 for my $ccvm (@$ccvms) {
2628 my $obj = "Fieldmapper::config::${ctype}_map"->new;
2629 $obj->value($ccvm->value);
2630 $obj->code($ccvm->code);
2631 $obj->description($ccvm->description) if $obj->can('description');
2640 __PACKAGE__->register_method(
2641 method => 'fetch_slim_record',
2642 api_name => 'open-ils.search.biblio.record_entry.slim.retrieve',
2644 desc => "Retrieves one or more biblio.record_entry without the attached marcxml",
2646 { desc => 'Array of Record IDs', type => 'array' }
2649 desc => 'Array of biblio records, event on error'
2654 sub fetch_slim_record {
2655 my( $self, $conn, $ids ) = @_;
2657 my $editor = new_editor();
2660 return $editor->event unless
2661 my $r = $editor->retrieve_biblio_record_entry($_);
2668 __PACKAGE__->register_method(
2669 method => 'rec_hold_parts',
2670 api_name => 'open-ils.search.biblio.record_hold_parts',
2672 Returns a list of {label :foo, id : bar} objects for viable monograph parts for a given record
2676 sub rec_hold_parts {
2677 my( $self, $conn, $args ) = @_;
2679 my $rec = $$args{record};
2680 my $mrec = $$args{metarecord};
2681 my $pickup_lib = $$args{pickup_lib};
2682 my $e = new_editor();
2685 select => {bmp => ['id', 'label']},
2690 select => {'acpm' => ['part']},
2691 from => {acpm => {acp => {join => {acn => {join => 'bre'}}}}},
2693 '+acp' => {'deleted' => 'f'},
2694 '+bre' => {id => $rec}
2701 order_by =>[{class=>'bmp', field=>'label_sortkey'}]
2704 if(defined $pickup_lib) {
2705 my $hard_boundary = $U->ou_ancestor_setting_value($pickup_lib, OILS_SETTING_HOLD_HARD_BOUNDARY);
2706 if($hard_boundary) {
2707 my $orgs = $e->json_query({from => ['actor.org_unit_descendants' => $pickup_lib, $hard_boundary]});
2708 $query->{where}->{'+acp'}->{circ_lib} = [ map { $_->{id} } @$orgs ];
2712 return $e->json_query($query);
2718 __PACKAGE__->register_method(
2719 method => 'rec_to_mr_rec_descriptors',
2720 api_name => 'open-ils.search.metabib.record_to_descriptors',
2722 specialized method...
2723 Given a biblio record id or a metarecord id,
2724 this returns a list of metabib.record_descriptor
2725 objects that live within the same metarecord
2726 @param args Object of args including:
2730 sub rec_to_mr_rec_descriptors {
2731 my( $self, $conn, $args ) = @_;
2733 my $rec = $$args{record};
2734 my $mrec = $$args{metarecord};
2735 my $item_forms = $$args{item_forms};
2736 my $item_types = $$args{item_types};
2737 my $item_lang = $$args{item_lang};
2738 my $pickup_lib = $$args{pickup_lib};
2740 my $hard_boundary = $U->ou_ancestor_setting_value($pickup_lib, OILS_SETTING_HOLD_HARD_BOUNDARY) if (defined $pickup_lib);
2742 my $e = new_editor();
2746 my $map = $e->search_metabib_metarecord_source_map({source => $rec});
2747 return $e->event unless @$map;
2748 $mrec = $$map[0]->metarecord;
2751 $recs = $e->search_metabib_metarecord_source_map({metarecord => $mrec});
2752 return $e->event unless @$recs;
2754 my @recs = map { $_->source } @$recs;
2755 my $search = { record => \@recs };
2756 $search->{item_form} = $item_forms if $item_forms and @$item_forms;
2757 $search->{item_type} = $item_types if $item_types and @$item_types;
2758 $search->{item_lang} = $item_lang if $item_lang;
2760 my $desc = $e->search_metabib_record_descriptor($search);
2764 select => { 'bre' => ['id'] },
2769 'acp' => {"join" => {"acpl" => {}, "ccs" => {}}}
2775 '+bre' => { id => \@recs },
2780 "+ccs" => { holdable => 't' },
2781 "+acpl" => { holdable => 't', deleted => 'f' }
2785 if ($hard_boundary) { # 0 (or "top") is the same as no setting
2786 my $orgs = $e->json_query(
2787 { from => [ 'actor.org_unit_descendants' => $pickup_lib, $hard_boundary ] }
2788 ) or return $e->die_event;
2790 $query->{where}->{"+acp"}->{circ_lib} = [ map { $_->{id} } @$orgs ];
2793 my $good_records = $e->json_query($query) or return $e->die_event;
2796 for my $d (@$desc) {
2797 if ( grep { $d->record == $_->{id} } @$good_records ) {
2804 return { metarecord => $mrec, descriptors => $desc };
2808 __PACKAGE__->register_method(
2809 method => 'fetch_age_protect',
2810 api_name => 'open-ils.search.copy.age_protect.retrieve.all',
2813 sub fetch_age_protect {
2814 return new_editor()->retrieve_all_config_rule_age_hold_protect();
2818 __PACKAGE__->register_method(
2819 method => 'copies_by_cn_label',
2820 api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label',
2823 __PACKAGE__->register_method(
2824 method => 'copies_by_cn_label',
2825 api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label.staff',
2828 sub copies_by_cn_label {
2829 my( $self, $conn, $record, $cn_parts, $circ_lib ) = @_;
2830 my $e = new_editor();
2831 my $cnp_id = $cn_parts->[0] eq '' ? -1 : $e->search_asset_call_number_prefix({label => $cn_parts->[0]}, {idlist=>1})->[0];
2832 my $cns_id = $cn_parts->[2] eq '' ? -1 : $e->search_asset_call_number_suffix({label => $cn_parts->[2]}, {idlist=>1})->[0];
2833 my $cns = $e->search_asset_call_number({record => $record, prefix => $cnp_id, label => $cn_parts->[1], suffix => $cns_id, deleted => 'f'}, {idlist=>1});
2834 return [] unless @$cns;
2836 # show all non-deleted copies in the staff client ...
2837 if ($self->api_name =~ /staff$/o) {
2838 return $e->search_asset_copy({call_number => $cns, circ_lib => $circ_lib, deleted => 'f'}, {idlist=>1});
2841 # ... otherwise, grab the copies ...
2842 my $copies = $e->search_asset_copy(
2843 [ {call_number => $cns, circ_lib => $circ_lib, deleted => 'f', opac_visible => 't'},
2844 {flesh => 1, flesh_fields => { acp => [ qw/location status/] } }
2848 # ... and test for location and status visibility
2849 return [ map { ($U->is_true($_->location->opac_visible) && $U->is_true($_->status->opac_visible)) ? ($_->id) : () } @$copies ];
2852 __PACKAGE__->register_method(
2853 method => 'bib_copies',
2854 api_name => 'open-ils.search.bib.copies',
2857 __PACKAGE__->register_method(
2858 method => 'bib_copies',
2859 api_name => 'open-ils.search.bib.copies.staff',
2864 my ($self, $client, $rec_id, $org, $depth, $limit, $offset, $pref_ou) = @_;
2865 my $is_staff = ($self->api_name =~ /staff/);
2867 my $cstore = OpenSRF::AppSession->create('open-ils.cstore');
2868 my $req = $cstore->request(
2869 'open-ils.cstore.json_query', mk_copy_query(
2870 $rec_id, $org, $depth, $limit, $offset, $pref_ou, $is_staff));
2873 while ($resp = $req->recv) {
2874 $client->respond($resp->content);
2880 # TODO: this comes almost directly from WWW/EGCatLoader/Record.pm
2886 my $copy_limit = shift;
2887 my $copy_offset = shift;
2888 my $pref_ou = shift;
2889 my $is_staff = shift;
2891 my $query = $U->basic_opac_copy_query(
2892 $rec_id, undef, undef, $copy_limit, $copy_offset, $is_staff
2895 if ($org) { # TODO: root org test
2896 # no need to add the org join filter if we're not actually filtering
2897 $query->{from}->{acp}->[1] = { aou => {
2903 select => {aou => [{
2905 transform => 'actor.org_unit_descendants',
2906 result_field => 'id',
2910 where => {id => $org}
2917 # Unsure if we want these in the shared function, leaving here for now
2918 unshift(@{$query->{order_by}},
2919 { class => "aou", field => 'id',
2920 transform => 'evergreen.rank_ou', params => [$org, $pref_ou]
2923 push(@{$query->{order_by}},
2924 { class => "acp", field => 'id',
2925 transform => 'evergreen.rank_cp'
2933 __PACKAGE__->register_method(
2934 method => 'catalog_record_summary',
2935 api_name => 'open-ils.search.biblio.record.catalog_summary',
2937 max_bundle_count => 1,
2939 desc => 'Stream of record data suitable for catalog display',
2941 {desc => 'Context org unit ID', type => 'number'},
2942 {desc => 'Array of Record IDs', type => 'array'}
2946 Stream of record summary objects including id, record,
2947 hold_count, copy_counts, display (metabib display
2948 fields), attributes (metabib record attrs), plus
2949 metabib_id and metabib_records for the metabib variant.
2954 __PACKAGE__->register_method(
2955 method => 'catalog_record_summary',
2956 api_name => 'open-ils.search.biblio.record.catalog_summary.staff',
2958 max_bundle_count => 1,
2959 signature => q/see open-ils.search.biblio.record.catalog_summary/
2961 __PACKAGE__->register_method(
2962 method => 'catalog_record_summary',
2963 api_name => 'open-ils.search.biblio.metabib.catalog_summary',
2965 max_bundle_count => 1,
2966 signature => q/see open-ils.search.biblio.record.catalog_summary/
2969 __PACKAGE__->register_method(
2970 method => 'catalog_record_summary',
2971 api_name => 'open-ils.search.biblio.metabib.catalog_summary.staff',
2973 max_bundle_count => 1,
2974 signature => q/see open-ils.search.biblio.record.catalog_summary/
2978 sub catalog_record_summary {
2979 my ($self, $client, $org_id, $record_ids) = @_;
2980 my $e = new_editor();
2982 my $is_meta = ($self->api_name =~ /metabib/);
2983 my $is_staff = ($self->api_name =~ /staff/);
2985 my $holds_method = $is_meta ?
2986 'open-ils.circ.mmr.holds.count' :
2987 'open-ils.circ.bre.holds.count';
2989 my $copy_method = $is_meta ?
2990 'open-ils.search.biblio.metarecord.copy_count':
2991 'open-ils.search.biblio.record.copy_count';
2993 $copy_method .= '.staff' if $is_staff;
2995 $copy_method = $self->method_lookup($copy_method); # local method
2997 for my $rec_id (@$record_ids) {
2999 my $response = $is_meta ?
3000 get_one_metarecord_summary($e, $rec_id) :
3001 get_one_record_summary($e, $rec_id);
3003 ($response->{copy_counts}) = $copy_method->run($org_id, $rec_id);
3005 $response->{hold_count} =
3006 $U->simplereq('open-ils.circ', $holds_method, $rec_id);
3008 $client->respond($response);
3014 # Start with a bib summary and augment the data with additional
3015 # metarecord content.
3016 sub get_one_metarecord_summary {
3017 my ($e, $rec_id) = @_;
3019 my $meta = $e->retrieve_metabib_metarecord($rec_id) or return {};
3020 my $maps = $e->search_metabib_metarecord_source_map({metarecord => $rec_id});
3022 my $bre_id = $meta->master_record;
3024 my $response = get_one_record_summary($e, $bre_id);
3026 $response->{metabib_id} = $rec_id;
3027 $response->{metabib_records} = [map {$_->source} @$maps];
3029 my @other_bibs = map {$_->source} grep {$_->source != $bre_id} @$maps;
3031 # Augment the record attributes with those of all of the records
3032 # linked to this metarecord.
3034 my $attrs = $e->search_metabib_record_attr_flat({id => \@other_bibs});
3036 my $attributes = $response->{attributes};
3038 for my $attr (@$attrs) {
3039 $attributes->{$attr->attr} = [] unless $attributes->{$attr->attr};
3040 push(@{$attributes->{$attr->attr}}, $attr->value) # avoid dupes
3041 unless grep {$_ eq $attr->value} @{$attributes->{$attr->attr}};
3048 sub get_one_record_summary {
3049 my ($e, $rec_id) = @_;
3051 my $bre = $e->retrieve_biblio_record_entry([$rec_id, {
3054 bre => [qw/compressed_display_entries mattrs creator editor/]
3058 # Compressed display fields are pachaged as JSON
3060 $display->{$_->name} = OpenSRF::Utils::JSON->JSON2perl($_->value)
3061 foreach @{$bre->compressed_display_entries};
3063 # Create an object of 'mraf' attributes.
3064 # Any attribute can be multi so dedupe and array-ify all of them.
3065 my $attributes = {};
3066 for my $attr (@{$bre->mattrs}) {
3067 $attributes->{$attr->attr} = {} unless $attributes->{$attr->attr};
3068 $attributes->{$attr->attr}->{$attr->value} = 1; # avoid dupes
3070 $attributes->{$_} = [keys %{$attributes->{$_}}] for keys %$attributes;
3075 $bre->clear_compressed_display_entries;
3080 display => $display,
3081 attributes => $attributes