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;
14 use OpenSRF::Utils::Logger qw/:logger/;
17 use OpenSRF::Utils::JSON;
19 use Time::HiRes qw(time);
20 use OpenSRF::EX qw(:try);
21 use Digest::MD5 qw(md5_hex);
27 $Data::Dumper::Indent = 0;
29 use OpenILS::Const qw/:const/;
31 use OpenILS::Application::AppUtils;
32 my $apputils = "OpenILS::Application::AppUtils";
35 my $pfx = "open-ils.search_";
43 $cache = OpenSRF::Utils::Cache->new('global');
44 my $sclient = OpenSRF::Utils::SettingsClient->new();
45 $cache_timeout = $sclient->config_value(
46 "apps", "open-ils.search", "app_settings", "cache_timeout" ) || 300;
48 $superpage_size = $sclient->config_value(
49 "apps", "open-ils.search", "app_settings", "superpage_size" ) || 500;
51 $max_superpages = $sclient->config_value(
52 "apps", "open-ils.search", "app_settings", "max_superpages" ) || 20;
54 $logger->info("Search cache timeout is $cache_timeout, ".
55 " superpage_size is $superpage_size, max_superpages is $max_superpages");
60 # ---------------------------------------------------------------------------
61 # takes a list of record id's and turns the docs into friendly
62 # mods structures. Creates one MODS structure for each doc id.
63 # ---------------------------------------------------------------------------
64 sub _records_to_mods {
70 my $session = OpenSRF::AppSession->create("open-ils.cstore");
71 my $request = $session->request(
72 "open-ils.cstore.direct.biblio.record_entry.search", { id => \@ids } );
74 while( my $resp = $request->recv ) {
75 my $content = $resp->content;
76 next if $content->id == OILS_PRECAT_RECORD;
77 my $u = OpenILS::Utils::ModsParser->new(); # FIXME: we really need a new parser for each object?
78 $u->start_mods_batch( $content->marc );
79 my $mods = $u->finish_mods_batch();
80 $mods->doc_id($content->id());
81 $mods->tcn($content->tcn_value);
85 $session->disconnect();
89 __PACKAGE__->register_method(
90 method => "record_id_to_mods",
91 api_name => "open-ils.search.biblio.record.mods.retrieve",
94 desc => "Provide ID, we provide the MODS object with copy count. "
95 . "Note: this method does NOT take an array of IDs like mods_slim.retrieve", # FIXME: do it here too
97 { desc => 'Record ID', type => 'number' }
100 desc => 'MODS object', type => 'object'
105 # converts a record into a mods object with copy counts attached
106 sub record_id_to_mods {
108 my( $self, $client, $org_id, $id ) = @_;
110 my $mods_list = _records_to_mods( $id );
111 my $mods_obj = $mods_list->[0];
112 my $cmethod = $self->method_lookup("open-ils.search.biblio.record.copy_count");
113 my ($count) = $cmethod->run($org_id, $id);
114 $mods_obj->copy_count($count);
121 __PACKAGE__->register_method(
122 method => "record_id_to_mods_slim",
123 api_name => "open-ils.search.biblio.record.mods_slim.retrieve",
127 desc => "Provide ID(s), we provide the MODS",
129 { desc => 'Record ID or array of IDs' }
132 desc => 'MODS object(s), event on error'
137 # converts a record into a mods object with NO copy counts attached
138 sub record_id_to_mods_slim {
139 my( $self, $client, $id ) = @_;
140 return undef unless defined $id;
142 if(ref($id) and ref($id) == 'ARRAY') {
143 return _records_to_mods( @$id );
145 my $mods_list = _records_to_mods( $id );
146 my $mods_obj = $mods_list->[0];
147 return OpenILS::Event->new('BIBLIO_RECORD_ENTRY_NOT_FOUND') unless $mods_obj;
153 __PACKAGE__->register_method(
154 method => "record_id_to_mods_slim_batch",
155 api_name => "open-ils.search.biblio.record.mods_slim.batch.retrieve",
158 sub record_id_to_mods_slim_batch {
159 my($self, $conn, $id_list) = @_;
160 $conn->respond(_records_to_mods($_)->[0]) for @$id_list;
165 # Returns the number of copies attached to a record based on org location
166 __PACKAGE__->register_method(
167 method => "record_id_to_copy_count",
168 api_name => "open-ils.search.biblio.record.copy_count",
170 desc => q/Returns a copy summary for the given record for the context org
171 unit and all ancestor org units/,
173 {desc => 'Context org unit id', type => 'number'},
174 {desc => 'Record ID', type => 'number'}
177 desc => q/summary object per org unit in the set, where the set
178 includes the context org unit and all parent org units.
179 Object includes the keys "transcendant", "count", "org_unit", "depth",
180 "unshadow", "available". Each is a count, except "org_unit" which is
181 the context org unit and "depth" which is the depth of the context org unit
188 __PACKAGE__->register_method(
189 method => "record_id_to_copy_count",
190 api_name => "open-ils.search.biblio.record.copy_count.staff",
193 desc => q/Returns a copy summary for the given record for the context org
194 unit and all ancestor org units/,
196 {desc => 'Context org unit id', type => 'number'},
197 {desc => 'Record ID', type => 'number'}
200 desc => q/summary object per org unit in the set, where the set
201 includes the context org unit and all parent org units.
202 Object includes the keys "transcendant", "count", "org_unit", "depth",
203 "unshadow", "available". Each is a count, except "org_unit" which is
204 the context org unit and "depth" which is the depth of the context org unit
211 __PACKAGE__->register_method(
212 method => "record_id_to_copy_count",
213 api_name => "open-ils.search.biblio.metarecord.copy_count",
215 desc => q/Returns a copy summary for the given record for the context org
216 unit and all ancestor org units/,
218 {desc => 'Context org unit id', type => 'number'},
219 {desc => 'Record ID', type => 'number'}
222 desc => q/summary object per org unit in the set, where the set
223 includes the context org unit and all parent org units.
224 Object includes the keys "transcendant", "count", "org_unit", "depth",
225 "unshadow", "available". Each is a count, except "org_unit" which is
226 the context org unit and "depth" which is the depth of the context org unit
233 __PACKAGE__->register_method(
234 method => "record_id_to_copy_count",
235 api_name => "open-ils.search.biblio.metarecord.copy_count.staff",
237 desc => q/Returns a copy summary for the given record for the context org
238 unit and all ancestor org units/,
240 {desc => 'Context org unit id', type => 'number'},
241 {desc => 'Record ID', type => 'number'}
244 desc => q/summary object per org unit in the set, where the set
245 includes the context org unit and all parent org units.
246 Object includes the keys "transcendant", "count", "org_unit", "depth",
247 "unshadow", "available". Each is a count, except "org_unit" which is
248 the context org unit and "depth" which is the depth of the context org
249 unit. "depth" is always -1 when the count from a lasso search is
250 performed, since depth doesn't mean anything in a lasso context.
257 sub record_id_to_copy_count {
258 my( $self, $client, $org_id, $record_id ) = @_;
260 return [] unless $record_id;
262 my $key = $self->api_name =~ /metarecord/ ? 'metarecord' : 'record';
263 my $staff = $self->api_name =~ /staff/ ? 't' : 'f';
265 my $data = $U->cstorereq(
266 "open-ils.cstore.json_query.atomic",
267 { from => ['asset.' . $key . '_copy_count' => $org_id => $record_id => $staff] }
271 for my $d ( @$data ) { # fix up the key name change required by stored-proc version
272 $$d{count} = delete $$d{visible};
276 return [ sort { $a->{depth} <=> $b->{depth} } @count ];
279 __PACKAGE__->register_method(
280 method => "record_has_holdable_copy",
281 api_name => "open-ils.search.biblio.record.has_holdable_copy",
283 desc => q/Returns a boolean indicating if a record has any holdable copies./,
285 {desc => 'Record ID', type => 'number'}
288 desc => q/bool indicating if the record has any holdable copies/,
294 __PACKAGE__->register_method(
295 method => "record_has_holdable_copy",
296 api_name => "open-ils.search.biblio.metarecord.has_holdable_copy",
298 desc => q/Returns a boolean indicating if a record has any holdable copies./,
300 {desc => 'Record ID', type => 'number'}
303 desc => q/bool indicating if the record has any holdable copies/,
309 sub record_has_holdable_copy {
310 my($self, $client, $record_id ) = @_;
312 return 0 unless $record_id;
314 my $key = $self->api_name =~ /metarecord/ ? 'metarecord' : 'record';
316 my $data = $U->cstorereq(
317 "open-ils.cstore.json_query.atomic",
318 { from => ['asset.' . $key . '_has_holdable_copy' => $record_id ] }
321 return ${@$data[0]}{'asset.' . $key . '_has_holdable_copy'} eq 't';
325 __PACKAGE__->register_method(
326 method => "biblio_search_tcn",
327 api_name => "open-ils.search.biblio.tcn",
330 desc => "Retrieve related record ID(s) given a TCN",
332 { desc => 'TCN', type => 'string' },
333 { desc => 'Flag indicating to include deleted records', type => 'string' }
336 desc => 'Results object like: { "count": $i, "ids": [...] }',
343 sub biblio_search_tcn {
345 my( $self, $client, $tcn, $include_deleted ) = @_;
347 $tcn =~ s/^\s+|\s+$//og;
349 my $e = new_editor();
350 my $search = {tcn_value => $tcn};
351 $search->{deleted} = 'f' unless $include_deleted;
352 my $recs = $e->search_biblio_record_entry( $search, {idlist =>1} );
354 return { count => scalar(@$recs), ids => $recs };
358 # --------------------------------------------------------------------------------
360 __PACKAGE__->register_method(
361 method => "biblio_barcode_to_copy",
362 api_name => "open-ils.search.asset.copy.find_by_barcode",
364 sub biblio_barcode_to_copy {
365 my( $self, $client, $barcode ) = @_;
366 my( $copy, $evt ) = $U->fetch_copy_by_barcode($barcode);
371 __PACKAGE__->register_method(
372 method => "biblio_id_to_copy",
373 api_name => "open-ils.search.asset.copy.batch.retrieve",
375 sub biblio_id_to_copy {
376 my( $self, $client, $ids ) = @_;
377 $logger->info("Fetching copies @$ids");
378 return $U->cstorereq(
379 "open-ils.cstore.direct.asset.copy.search.atomic", { id => $ids } );
383 __PACKAGE__->register_method(
384 method => "biblio_id_to_uris",
385 api_name=> "open-ils.search.asset.uri.retrieve_by_bib",
389 @param BibID Which bib record contains the URIs
390 @param OrgID Where to look for URIs
391 @param OrgDepth Range adjustment for OrgID
392 @return A stream or list of 'auri' objects
396 sub biblio_id_to_uris {
397 my( $self, $client, $bib, $org, $depth ) = @_;
398 die "Org ID required" unless defined($org);
399 die "Bib ID required" unless defined($bib);
402 push @params, $depth if (defined $depth);
404 my $ids = $U->cstorereq( "open-ils.cstore.json_query.atomic",
405 { select => { auri => [ 'id' ] },
409 field => 'call_number',
415 filter => { active => 't' }
426 select => { aou => [ { column => 'id', transform => 'actor.org_unit_descendants', params => \@params, result_field => 'id' } ] },
428 where => { id => $org },
438 my $uris = $U->cstorereq(
439 "open-ils.cstore.direct.asset.uri.search.atomic",
440 { id => [ map { (values %$_) } @$ids ] }
443 $client->respond($_) for (@$uris);
449 __PACKAGE__->register_method(
450 method => "copy_retrieve",
451 api_name => "open-ils.search.asset.copy.retrieve",
454 desc => 'Retrieve a copy object based on the Copy ID',
456 { desc => 'Copy ID', type => 'number'}
459 desc => 'Copy object, event on error'
465 my( $self, $client, $cid ) = @_;
466 my( $copy, $evt ) = $U->fetch_copy($cid);
467 return $evt || $copy;
470 __PACKAGE__->register_method(
471 method => "volume_retrieve",
472 api_name => "open-ils.search.asset.call_number.retrieve"
474 sub volume_retrieve {
475 my( $self, $client, $vid ) = @_;
476 my $e = new_editor();
477 my $vol = $e->retrieve_asset_call_number($vid) or return $e->event;
481 __PACKAGE__->register_method(
482 method => "fleshed_copy_retrieve_batch",
483 api_name => "open-ils.search.asset.copy.fleshed.batch.retrieve",
487 sub fleshed_copy_retrieve_batch {
488 my( $self, $client, $ids ) = @_;
489 $logger->info("Fetching fleshed copies @$ids");
490 return $U->cstorereq(
491 "open-ils.cstore.direct.asset.copy.search.atomic",
494 flesh_fields => { acp => [ qw/ circ_lib location status stat_cat_entries parts / ] }
499 __PACKAGE__->register_method(
500 method => "fleshed_copy_retrieve",
501 api_name => "open-ils.search.asset.copy.fleshed.retrieve",
504 sub fleshed_copy_retrieve {
505 my( $self, $client, $id ) = @_;
506 my( $c, $e) = $U->fetch_fleshed_copy($id);
511 __PACKAGE__->register_method(
512 method => 'fleshed_by_barcode',
513 api_name => "open-ils.search.asset.copy.fleshed2.find_by_barcode",
516 sub fleshed_by_barcode {
517 my( $self, $conn, $barcode ) = @_;
518 my $e = new_editor();
519 my $copyid = $e->search_asset_copy(
520 {barcode => $barcode, deleted => 'f'}, {idlist=>1})->[0]
522 return fleshed_copy_retrieve2( $self, $conn, $copyid);
526 __PACKAGE__->register_method(
527 method => "fleshed_copy_retrieve2",
528 api_name => "open-ils.search.asset.copy.fleshed2.retrieve",
532 sub fleshed_copy_retrieve2 {
533 my( $self, $client, $id ) = @_;
534 my $e = new_editor();
535 my $copy = $e->retrieve_asset_copy(
542 qw/ location status stat_cat_entry_copy_maps notes age_protect parts peer_record_maps /
544 ascecm => [qw/ stat_cat stat_cat_entry /],
548 ) or return $e->event;
550 # For backwards compatibility
551 #$copy->stat_cat_entries($copy->stat_cat_entry_copy_maps);
553 if( $copy->status->id == OILS_COPY_STATUS_CHECKED_OUT ) {
555 $e->search_action_circulation(
557 { target_copy => $copy->id },
559 order_by => { circ => 'xact_start desc' },
571 __PACKAGE__->register_method(
572 method => 'flesh_copy_custom',
573 api_name => 'open-ils.search.asset.copy.fleshed.custom',
577 sub flesh_copy_custom {
578 my( $self, $conn, $copyid, $fields ) = @_;
579 my $e = new_editor();
580 my $copy = $e->retrieve_asset_copy(
590 ) or return $e->event;
595 __PACKAGE__->register_method(
596 method => "biblio_barcode_to_title",
597 api_name => "open-ils.search.biblio.find_by_barcode",
600 sub biblio_barcode_to_title {
601 my( $self, $client, $barcode ) = @_;
603 my $title = $apputils->simple_scalar_request(
605 "open-ils.storage.biblio.record_entry.retrieve_by_barcode", $barcode );
607 return { ids => [ $title->id ], count => 1 } if $title;
608 return { count => 0 };
611 __PACKAGE__->register_method(
612 method => 'title_id_by_item_barcode',
613 api_name => 'open-ils.search.bib_id.by_barcode',
616 desc => 'Retrieve bib record id associated with the copy identified by the given barcode',
618 { desc => 'Item barcode', type => 'string' }
621 desc => 'Bib record id.'
626 __PACKAGE__->register_method(
627 method => 'title_id_by_item_barcode',
628 api_name => 'open-ils.search.multi_home.bib_ids.by_barcode',
631 desc => 'Retrieve bib record ids associated with the copy identified by the given barcode. This includes peer bibs for Multi-Home items.',
633 { desc => 'Item barcode', type => 'string' }
636 desc => 'Array of bib record ids. First element is the native bib for the item.'
642 sub title_id_by_item_barcode {
643 my( $self, $conn, $barcode ) = @_;
644 my $e = new_editor();
645 my $copies = $e->search_asset_copy(
647 { deleted => 'f', barcode => $barcode },
651 acp => [ 'call_number' ],
658 return $e->event unless @$copies;
660 if( $self->api_name =~ /multi_home/ ) {
661 my $multi_home_list = $e->search_biblio_peer_bib_copy_map(
663 { target_copy => $$copies[0]->id }
666 my @temp = map { $_->peer_record } @{ $multi_home_list };
667 unshift @temp, $$copies[0]->call_number->record->id;
670 return $$copies[0]->call_number->record->id;
674 __PACKAGE__->register_method(
675 method => 'find_peer_bibs',
676 api_name => 'open-ils.search.peer_bibs.test',
679 desc => 'Tests to see if the specified record is a peer record.',
681 { desc => 'Biblio record entry Id', type => 'number' }
684 desc => 'True if specified id can be found in biblio.peer_bib_copy_map.peer_record.',
690 __PACKAGE__->register_method(
691 method => 'find_peer_bibs',
692 api_name => 'open-ils.search.peer_bibs',
695 desc => 'Return acps and mvrs for multi-home items linked to specified peer record.',
697 { desc => 'Biblio record entry Id', type => 'number' }
700 desc => '{ records => Array of mvrs, items => array of acps }',
707 my( $self, $client, $doc_id ) = @_;
708 my $e = new_editor();
710 my $multi_home_list = $e->search_biblio_peer_bib_copy_map(
712 { peer_record => $doc_id },
716 bpbcm => [ 'target_copy', 'peer_type' ],
717 acp => [ 'call_number', 'location', 'status', 'peer_record_maps' ]
723 if ($self->api_name =~ /test/) {
724 return scalar( @{$multi_home_list} ) > 0 ? 1 : 0;
727 if (scalar(@{$multi_home_list})==0) {
731 # create a unique hash of the primary record MVRs for foreign copies
732 # XXX PLEASE let's change to unAPI2 (supports foreign copies) in the TT opac?!?
734 ($_->target_copy->call_number->record, _records_to_mods( $_->target_copy->call_number->record )->[0])
737 # set the foreign_copy_maps field to an empty array
738 map { $rec_hash{$_}->foreign_copy_maps([]) } keys( %rec_hash );
740 # push the maps onto the correct MVRs
741 for (@$multi_home_list) {
743 @{$rec_hash{ $_->target_copy->call_number->record }->foreign_copy_maps()},
748 return [sort {$a->title cmp $b->title} values(%rec_hash)];
751 __PACKAGE__->register_method(
752 method => "biblio_copy_to_mods",
753 api_name => "open-ils.search.biblio.copy.mods.retrieve",
756 # takes a copy object and returns it fleshed mods object
757 sub biblio_copy_to_mods {
758 my( $self, $client, $copy ) = @_;
760 my $volume = $U->cstorereq(
761 "open-ils.cstore.direct.asset.call_number.retrieve",
762 $copy->call_number() );
764 my $mods = _records_to_mods($volume->record());
765 $mods = shift @$mods;
766 $volume->copies([$copy]);
767 push @{$mods->call_numbers()}, $volume;
775 OpenILS::Application::Search::Biblio
781 =head3 open-ils.search.biblio.multiclass.query (arghash, query, docache)
783 For arghash and docache, see B<open-ils.search.biblio.multiclass>.
785 The query argument is a string, but built like a hash with key: value pairs.
786 Recognized search keys include:
788 keyword (kw) - search keyword(s) *
789 author (au) - search author(s) *
790 name (au) - same as author *
791 title (ti) - search title *
792 subject (su) - search subject *
793 series (se) - search series *
794 lang - limit by language (specifiy multiple langs with lang:l1 lang:l2 ...)
795 site - search at specified org unit, corresponds to actor.org_unit.shortname
796 pref_ou - extend search to specified org unit, corresponds to actor.org_unit.shortname
797 sort - sort type (title, author, pubdate)
798 dir - sort direction (asc, desc)
799 available - if set to anything other than "false" or "0", limits to available items
801 * Searching keyword, author, title, subject, and series supports additional search
802 subclasses, specified with a "|". For example, C<title|proper:gone with the wind>.
804 For more, see B<config.metabib_field>.
808 foreach (qw/open-ils.search.biblio.multiclass.query
809 open-ils.search.biblio.multiclass.query.staff
810 open-ils.search.metabib.multiclass.query
811 open-ils.search.metabib.multiclass.query.staff/)
813 __PACKAGE__->register_method(
815 method => 'multiclass_query',
817 desc => 'Perform a search query. The .staff version of the call includes otherwise hidden hits.',
819 {name => 'arghash', desc => 'Arg hash (see open-ils.search.biblio.multiclass)', type => 'object'},
820 {name => 'query', desc => 'Raw human-readable query (see perldoc '. __PACKAGE__ .')', type => 'string'},
821 {name => 'docache', desc => 'Flag for caching (see open-ils.search.biblio.multiclass)', type => 'object'},
824 desc => 'Search results from query, like: { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }',
825 type => 'object', # TODO: update as miker's new elements are included
831 sub multiclass_query {
832 my($self, $conn, $arghash, $query, $docache) = @_;
834 $logger->debug("initial search query => $query");
835 my $orig_query = $query;
838 $query =~ s/^\s+//go;
840 # convert convenience classes (e.g. kw for keyword) to the full class name
841 # ensure that the convenience class isn't part of a word (e.g. 'playhouse')
842 $query =~ s/(^|\s)kw(:|\|)/$1keyword$2/go;
843 $query =~ s/(^|\s)ti(:|\|)/$1title$2/go;
844 $query =~ s/(^|\s)au(:|\|)/$1author$2/go;
845 $query =~ s/(^|\s)su(:|\|)/$1subject$2/go;
846 $query =~ s/(^|\s)se(:|\|)/$1series$2/go;
847 $query =~ s/(^|\s)name(:|\|)/$1author$2/og;
849 $logger->debug("cleansed query string => $query");
852 my $simple_class_re = qr/((?:\w+(?:\|\w+)?):[^:]+?)$/;
853 my $class_list_re = qr/(?:keyword|title|author|subject|series)/;
854 my $modifier_list_re = qr/(?:site|dir|sort|lang|available|preflib)/;
857 while ($query =~ s/$simple_class_re//so) {
860 my $where = index($qpart,':');
861 my $type = substr($qpart, 0, $where++);
862 my $value = substr($qpart, $where);
864 if ($type !~ /^(?:$class_list_re|$modifier_list_re)/o) {
865 $tmp_value = "$qpart $tmp_value";
869 if ($type =~ /$class_list_re/o ) {
870 $value .= $tmp_value;
874 next unless $type and $value;
876 $value =~ s/^\s*//og;
877 $value =~ s/\s*$//og;
878 $type = 'sort_dir' if $type eq 'dir';
880 if($type eq 'site') {
881 # 'site' is the org shortname. when using this, we also want
882 # to search at the requested org's depth
883 my $e = new_editor();
884 if(my $org = $e->search_actor_org_unit({shortname => $value})->[0]) {
885 $arghash->{org_unit} = $org->id if $org;
886 $arghash->{depth} = $e->retrieve_actor_org_unit_type($org->ou_type)->depth;
888 $logger->warn("'site:' query used on invalid org shortname: $value ... ignoring");
890 } elsif($type eq 'pref_ou') {
891 # 'pref_ou' is the preferred org shortname.
892 my $e = new_editor();
893 if(my $org = $e->search_actor_org_unit({shortname => $value})->[0]) {
894 $arghash->{pref_ou} = $org->id if $org;
896 $logger->warn("'pref_ou:' query used on invalid org shortname: $value ... ignoring");
899 } elsif($type eq 'available') {
901 $arghash->{available} = 1 unless $value eq 'false' or $value eq '0';
903 } elsif($type eq 'lang') {
904 # collect languages into an array of languages
905 $arghash->{language} = [] unless $arghash->{language};
906 push(@{$arghash->{language}}, $value);
908 } elsif($type =~ /^sort/o) {
909 # sort and sort_dir modifiers
910 $arghash->{$type} = $value;
913 # append the search term to the term under construction
914 $search->{$type} = {} unless $search->{$type};
915 $search->{$type}->{term} =
916 ($search->{$type}->{term}) ? $search->{$type}->{term} . " $value" : $value;
920 $query .= " $tmp_value";
921 $query =~ s/\s+/ /go;
922 $query =~ s/^\s+//go;
923 $query =~ s/\s+$//go;
925 my $type = $arghash->{default_class} || 'keyword';
926 $type = ($type eq '-') ? 'keyword' : $type;
927 $type = ($type !~ /^(title|author|keyword|subject|series)(?:\|\w+)?$/o) ? 'keyword' : $type;
930 # This is the front part of the string before any special tokens were
931 # parsed OR colon-separated strings that do not denote a class.
932 # Add this data to the default search class
933 $search->{$type} = {} unless $search->{$type};
934 $search->{$type}->{term} =
935 ($search->{$type}->{term}) ? $search->{$type}->{term} . " $query" : $query;
937 my $real_search = $arghash->{searches} = { $type => { term => $orig_query } };
939 # capture the original limit because the search method alters the limit internally
940 my $ol = $arghash->{limit};
942 my $sclient = OpenSRF::Utils::SettingsClient->new;
944 (my $method = $self->api_name) =~ s/\.query//o;
946 $method =~ s/multiclass/multiclass.staged/
947 if $sclient->config_value(apps => 'open-ils.search',
948 app_settings => 'use_staged_search') =~ /true/i;
950 # XXX This stops the session locale from doing the right thing.
951 # XXX Revisit this and have it translate to a lang instead of a locale.
952 #$arghash->{preferred_language} = $U->get_org_locale($arghash->{org_unit})
953 # unless $arghash->{preferred_language};
955 $method = $self->method_lookup($method);
956 my ($data) = $method->run($arghash, $docache);
958 $arghash->{searches} = $search if (!$data->{complex_query});
960 $arghash->{limit} = $ol if $ol;
961 $data->{compiled_search} = $arghash;
962 $data->{query} = $orig_query;
964 $logger->info("compiled search is " . OpenSRF::Utils::JSON->perl2JSON($arghash));
969 __PACKAGE__->register_method(
970 method => 'cat_search_z_style_wrapper',
971 api_name => 'open-ils.search.biblio.zstyle',
973 signature => q/@see open-ils.search.biblio.multiclass/
976 __PACKAGE__->register_method(
977 method => 'cat_search_z_style_wrapper',
978 api_name => 'open-ils.search.biblio.zstyle.staff',
980 signature => q/@see open-ils.search.biblio.multiclass/
983 sub cat_search_z_style_wrapper {
986 my $authtoken = shift;
989 my $cstore = OpenSRF::AppSession->connect('open-ils.cstore');
991 my $ou = $cstore->request(
992 'open-ils.cstore.direct.actor.org_unit.search',
993 { parent_ou => undef }
996 my $result = { service => 'native-evergreen-catalog', records => [] };
997 my $searchhash = { limit => $$args{limit}, offset => $$args{offset}, org_unit => $ou->id };
999 $$searchhash{searches}{title}{term} = $$args{search}{title} if $$args{search}{title};
1000 $$searchhash{searches}{author}{term} = $$args{search}{author} if $$args{search}{author};
1001 $$searchhash{searches}{subject}{term} = $$args{search}{subject} if $$args{search}{subject};
1002 $$searchhash{searches}{keyword}{term} = $$args{search}{keyword} if $$args{search}{keyword};
1003 $$searchhash{searches}{'identifier|isbn'}{term} = $$args{search}{isbn} if $$args{search}{isbn};
1004 $$searchhash{searches}{'identifier|issn'}{term} = $$args{search}{issn} if $$args{search}{issn};
1006 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{tcn} if $$args{search}{tcn};
1007 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{publisher} if $$args{search}{publisher};
1008 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{pubdate} if $$args{search}{pubdate};
1009 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{item_type} if $$args{search}{item_type};
1011 my $list = the_quest_for_knowledge( $self, $client, $searchhash );
1013 if ($list->{count} > 0 and @{$list->{ids}}) {
1014 $result->{count} = $list->{count};
1016 my $records = $cstore->request(
1017 'open-ils.cstore.direct.biblio.record_entry.search.atomic',
1018 { id => [ map { ( $_->[0] ) } @{$list->{ids}} ] }
1021 for my $rec ( @$records ) {
1023 my $u = OpenILS::Utils::ModsParser->new();
1024 $u->start_mods_batch( $rec->marc );
1025 my $mods = $u->finish_mods_batch();
1027 push @{ $result->{records} }, { mvr => $mods, marcxml => $rec->marc, bibid => $rec->id };
1033 $cstore->disconnect();
1037 # ----------------------------------------------------------------------------
1038 # These are the main OPAC search methods
1039 # ----------------------------------------------------------------------------
1041 __PACKAGE__->register_method(
1042 method => 'the_quest_for_knowledge',
1043 api_name => 'open-ils.search.biblio.multiclass',
1045 desc => "Performs a multi class biblio or metabib search",
1048 desc => "A search hash with keys: "
1049 . "searches, org_unit, depth, limit, offset, format, sort, sort_dir. "
1050 . "See perldoc " . __PACKAGE__ . " for more detail",
1054 desc => "A flag to enable/disable searching and saving results in cache (default OFF)",
1059 desc => 'An object of the form: '
1060 . '{ "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }',
1065 =head3 open-ils.search.biblio.multiclass (search-hash, docache)
1067 The search-hash argument can have the following elements:
1069 searches: { "$class" : "$value", ...} [REQUIRED]
1070 org_unit: The org id to focus the search at
1071 depth : The org depth
1072 limit : The search limit default: 10
1073 offset : The search offset default: 0
1074 format : The MARC format
1075 sort : What field to sort the results on? [ author | title | pubdate ]
1076 sort_dir: What direction do we sort? [ asc | desc ]
1077 tag_circulated_records : Boolean, if true, records that are in the user's visible checkout history
1078 will be tagged with an additional value ("1") as the last value in the record ID array for
1079 each record. Requires the 'authtoken'
1080 authtoken : Authentication token string; When actions are performed that require a user login
1081 (e.g. tagging circulated records), the authentication token is required
1083 The searches element is required, must have a hashref value, and the hashref must contain at least one
1084 of the following classes as a key:
1092 The value paired with a key is the associated search string.
1094 The docache argument enables/disables searching and saving results in cache (default OFF).
1096 The return object, if successful, will look like:
1098 { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }
1102 __PACKAGE__->register_method(
1103 method => 'the_quest_for_knowledge',
1104 api_name => 'open-ils.search.biblio.multiclass.staff',
1105 signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items. Otherwise, @see open-ils.search.biblio.multiclass/
1107 __PACKAGE__->register_method(
1108 method => 'the_quest_for_knowledge',
1109 api_name => 'open-ils.search.metabib.multiclass',
1110 signature => q/@see open-ils.search.biblio.multiclass/
1112 __PACKAGE__->register_method(
1113 method => 'the_quest_for_knowledge',
1114 api_name => 'open-ils.search.metabib.multiclass.staff',
1115 signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items. Otherwise, @see open-ils.search.biblio.multiclass/
1118 sub the_quest_for_knowledge {
1119 my( $self, $conn, $searchhash, $docache ) = @_;
1121 return { count => 0 } unless $searchhash and
1122 ref $searchhash->{searches} eq 'HASH';
1124 my $method = 'open-ils.storage.biblio.multiclass.search_fts';
1128 if($self->api_name =~ /metabib/) {
1130 $method =~ s/biblio/metabib/o;
1133 # do some simple sanity checking
1134 if(!$searchhash->{searches} or
1135 ( !grep { /^(?:title|author|subject|series|keyword|identifier\|is[bs]n)/ } keys %{$searchhash->{searches}} ) ) {
1136 return { count => 0 };
1139 my $offset = $searchhash->{offset} || 0; # user value or default in local var now
1140 my $limit = $searchhash->{limit} || 10; # user value or default in local var now
1141 my $end = $offset + $limit - 1;
1143 my $maxlimit = 5000;
1144 $searchhash->{offset} = 0; # possible user value overwritten in hash
1145 $searchhash->{limit} = $maxlimit; # possible user value overwritten in hash
1147 return { count => 0 } if $offset > $maxlimit;
1150 push( @search, ($_ => $$searchhash{$_})) for (sort keys %$searchhash);
1151 my $s = OpenSRF::Utils::JSON->perl2JSON(\@search);
1152 my $ckey = $pfx . md5_hex($method . $s);
1154 $logger->info("bib search for: $s");
1156 $searchhash->{limit} -= $offset;
1160 my $result = ($docache) ? search_cache($ckey, $offset, $limit) : undef;
1164 $method .= ".staff" if($self->api_name =~ /staff/);
1165 $method .= ".atomic";
1167 for (keys %$searchhash) {
1168 delete $$searchhash{$_}
1169 unless defined $$searchhash{$_};
1172 $result = $U->storagereq( $method, %$searchhash );
1176 $docache = 0; # results came FROM cache, so we don't write back
1179 return {count => 0} unless ($result && $$result[0]);
1183 my $count = ($ismeta) ? $result->[0]->[3] : $result->[0]->[2];
1186 # If we didn't get this data from the cache, put it into the cache
1187 # then return the correct offset of records
1188 $logger->debug("putting search cache $ckey\n");
1189 put_cache($ckey, $count, \@recs);
1193 # if we have the full set of data, trim out
1194 # the requested chunk based on limit and offset
1196 for ($offset..$end) {
1197 last unless $recs[$_];
1198 push(@t, $recs[$_]);
1203 return { ids => \@recs, count => $count };
1207 __PACKAGE__->register_method(
1208 method => 'staged_search',
1209 api_name => 'open-ils.search.biblio.multiclass.staged',
1211 desc => 'Staged search filters out unavailable items. This means that it relies on an estimation strategy for determining ' .
1212 'how big a "raw" search result chunk (i.e. a "superpage") to obtain prior to filtering. See "estimation_strategy" in your SRF config.',
1215 desc => "A search hash with keys: "
1216 . "searches, limit, offset. The others are optional, but the 'searches' key/value pair is required, with the value being a hashref. "
1217 . "See perldoc " . __PACKAGE__ . " for more detail",
1221 desc => "A flag to enable/disable searching and saving results in cache, including facets (default OFF)",
1226 desc => 'Hash with keys: count, core_limit, superpage_size, superpage_summary, facet_key, ids. '
1227 . 'The superpage_summary value is a hashref that includes keys: estimated_hit_count, visible.',
1232 __PACKAGE__->register_method(
1233 method => 'staged_search',
1234 api_name => 'open-ils.search.biblio.multiclass.staged.staff',
1235 signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items. Otherwise, @see open-ils.search.biblio.multiclass.staged/
1237 __PACKAGE__->register_method(
1238 method => 'staged_search',
1239 api_name => 'open-ils.search.metabib.multiclass.staged',
1240 signature => q/@see open-ils.search.biblio.multiclass.staged/
1242 __PACKAGE__->register_method(
1243 method => 'staged_search',
1244 api_name => 'open-ils.search.metabib.multiclass.staged.staff',
1245 signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items. Otherwise, @see open-ils.search.biblio.multiclass.staged/
1249 my($self, $conn, $search_hash, $docache) = @_;
1251 my $IAmMetabib = ($self->api_name =~ /metabib/) ? 1 : 0;
1253 my $method = $IAmMetabib?
1254 'open-ils.storage.metabib.multiclass.staged.search_fts':
1255 'open-ils.storage.biblio.multiclass.staged.search_fts';
1257 $method .= '.staff' if $self->api_name =~ /staff$/;
1258 $method .= '.atomic';
1260 return {count => 0} unless (
1262 $search_hash->{searches} and
1263 scalar( keys %{$search_hash->{searches}} ));
1265 my $search_duration;
1266 my $user_offset = $search_hash->{offset} || 0; # user-specified offset
1267 my $user_limit = $search_hash->{limit} || 10;
1268 my $ignore_facet_classes = $search_hash->{ignore_facet_classes};
1269 $user_offset = ($user_offset >= 0) ? $user_offset : 0;
1270 $user_limit = ($user_limit >= 0) ? $user_limit : 10;
1273 # we're grabbing results on a per-superpage basis, which means the
1274 # limit and offset should coincide with superpage boundaries
1275 $search_hash->{offset} = 0;
1276 $search_hash->{limit} = $superpage_size;
1278 # force a well-known check_limit
1279 $search_hash->{check_limit} = $superpage_size;
1280 # restrict total tested to superpage size * number of superpages
1281 $search_hash->{core_limit} = $superpage_size * $max_superpages;
1283 # Set the configured estimation strategy, defaults to 'inclusion'.
1284 my $estimation_strategy = OpenSRF::Utils::SettingsClient
1287 apps => 'open-ils.search', app_settings => 'estimation_strategy'
1289 $search_hash->{estimation_strategy} = $estimation_strategy;
1291 # pull any existing results from the cache
1292 my $key = search_cache_key($method, $search_hash);
1293 my $facet_key = $key.'_facets';
1294 my $cache_data = $cache->get_cache($key) || {};
1296 # keep retrieving results until we find enough to
1297 # fulfill the user-specified limit and offset
1298 my $all_results = [];
1299 my $page; # current superpage
1300 my $est_hit_count = 0;
1301 my $current_page_summary = {};
1302 my $global_summary = {checked => 0, visible => 0, excluded => 0, deleted => 0, total => 0};
1303 my $is_real_hit_count = 0;
1306 for($page = 0; $page < $max_superpages; $page++) {
1308 my $data = $cache_data->{$page};
1312 $logger->debug("staged search: analyzing superpage $page");
1315 # this window of results is already cached
1316 $logger->debug("staged search: found cached results");
1317 $summary = $data->{summary};
1318 $results = $data->{results};
1321 # retrieve the window of results from the database
1322 $logger->debug("staged search: fetching results from the database");
1323 $search_hash->{skip_check} = $page * $superpage_size;
1325 $results = $U->storagereq($method, %$search_hash);
1326 $search_duration = time - $start;
1327 $summary = shift(@$results) if $results;
1330 $logger->info("search timed out: duration=$search_duration: params=".
1331 OpenSRF::Utils::JSON->perl2JSON($search_hash));
1332 return {count => 0};
1335 $logger->info("staged search: DB call took $search_duration seconds and returned ".scalar(@$results)." rows, including summary");
1337 my $hc = $summary->{estimated_hit_count} || $summary->{visible};
1339 $logger->info("search returned 0 results: duration=$search_duration: params=".
1340 OpenSRF::Utils::JSON->perl2JSON($search_hash));
1343 # Create backwards-compatible result structures
1345 $results = [map {[$_->{id}, $_->{rel}, $_->{record}]} @$results];
1347 $results = [map {[$_->{id}]} @$results];
1350 push @$new_ids, grep {defined($_)} map {$_->[0]} @$results;
1351 $results = [grep {defined $_->[0]} @$results];
1352 cache_staged_search_page($key, $page, $summary, $results) if $docache;
1355 tag_circulated_records($search_hash->{authtoken}, $results, $IAmMetabib)
1356 if $search_hash->{tag_circulated_records} and $search_hash->{authtoken};
1358 $current_page_summary = $summary;
1360 # add the new set of results to the set under construction
1361 push(@$all_results, @$results);
1363 my $current_count = scalar(@$all_results);
1365 $est_hit_count = $summary->{estimated_hit_count} || $summary->{visible}
1368 $logger->debug("staged search: located $current_count, with estimated hits=".
1369 $summary->{estimated_hit_count}." : visible=".$summary->{visible}.", checked=".$summary->{checked});
1371 if (defined($summary->{estimated_hit_count})) {
1372 foreach (qw/ checked visible excluded deleted /) {
1373 $global_summary->{$_} += $summary->{$_};
1375 $global_summary->{total} = $summary->{total};
1378 # we've found all the possible hits
1379 last if $current_count == $summary->{visible}
1380 and not defined $summary->{estimated_hit_count};
1382 # we've found enough results to satisfy the requested limit/offset
1383 last if $current_count >= ($user_limit + $user_offset);
1385 # we've scanned all possible hits
1386 if($summary->{checked} < $superpage_size) {
1387 $est_hit_count = scalar(@$all_results);
1388 # we have all possible results in hand, so we know the final hit count
1389 $is_real_hit_count = 1;
1394 my @results = grep {defined $_} @$all_results[$user_offset..($user_offset + $user_limit - 1)];
1396 # refine the estimate if we have more than one superpage
1397 if ($page > 0 and not $is_real_hit_count) {
1398 if ($global_summary->{checked} >= $global_summary->{total}) {
1399 $est_hit_count = $global_summary->{visible};
1401 my $updated_hit_count = $U->storagereq(
1402 'open-ils.storage.fts_paging_estimate',
1403 $global_summary->{checked},
1404 $global_summary->{visible},
1405 $global_summary->{excluded},
1406 $global_summary->{deleted},
1407 $global_summary->{total}
1409 $est_hit_count = $updated_hit_count->{$estimation_strategy};
1413 $conn->respond_complete(
1415 count => $est_hit_count,
1416 core_limit => $search_hash->{core_limit},
1417 superpage_size => $search_hash->{check_limit},
1418 superpage_summary => $current_page_summary,
1419 facet_key => $facet_key,
1424 cache_facets($facet_key, $new_ids, $IAmMetabib, $ignore_facet_classes) if $docache;
1429 sub tag_circulated_records {
1430 my ($auth, $results, $metabib) = @_;
1431 my $e = new_editor(authtoken => $auth);
1432 return $results unless $e->checkauth;
1435 select => { acn => [{ column => 'record', alias => 'tagme' }] },
1436 from => { acp => 'acn' },
1437 where => { id => { in => { from => ['action.usr_visible_circ_copies', $e->requestor->id] } } },
1443 select => { mmsm => [{ column => 'metarecord', alias => 'tagme' }] },
1445 where => { source => { in => $query } },
1450 # Give me the distinct set of bib records that exist in the user's visible circulation history
1451 my $circ_recs = $e->json_query( $query );
1453 # if the record appears in the circ history, push a 1 onto
1454 # the rec array structure to indicate truthiness
1455 for my $rec (@$results) {
1456 push(@$rec, 1) if grep { $_->{tagme} eq $$rec[0] } @$circ_recs;
1462 # creates a unique token to represent the query in the cache
1463 sub search_cache_key {
1465 my $search_hash = shift;
1467 for my $key (sort keys %$search_hash) {
1468 push(@sorted, ($key => $$search_hash{$key}))
1469 unless $key eq 'limit' or
1471 $key eq 'skip_check';
1473 my $s = OpenSRF::Utils::JSON->perl2JSON(\@sorted);
1474 return $pfx . md5_hex($method . $s);
1477 sub retrieve_cached_facets {
1483 return undef unless ($key and $key =~ /_facets$/);
1485 my $blob = $cache->get_cache($key) || {};
1489 for my $f ( keys %$blob ) {
1490 my @sorted = map{ { $$_[1] => $$_[0] } } sort {$$b[0] <=> $$a[0] || $$a[1] cmp $$b[1]} map { [$$blob{$f}{$_}, $_] } keys %{ $$blob{$f} };
1491 @sorted = @sorted[0 .. $limit - 1] if (scalar(@sorted) > $limit);
1492 for my $s ( @sorted ) {
1493 my ($k) = keys(%$s);
1494 my ($v) = values(%$s);
1495 $$facets{$f}{$k} = $v;
1505 __PACKAGE__->register_method(
1506 method => "retrieve_cached_facets",
1507 api_name => "open-ils.search.facet_cache.retrieve",
1509 desc => 'Returns facet data derived from a specific search based on a key '.
1510 'generated by open-ils.search.biblio.multiclass.staged and friends.',
1513 desc => "The facet cache key returned with the initial search as the facet_key hash value",
1518 desc => 'Two level hash of facet values. Top level key is the facet id defined on the config.metabib_field table. '.
1519 'Second level key is a string facet value. Datum attached to each facet value is the number of distinct records, '.
1520 'or metarecords for a metarecord search, which use that facet value and are visible to the search at the time of '.
1521 'facet retrieval. These counts are calculated for all superpages that have been checked for visibility.',
1529 # add facets for this search to the facet cache
1530 my($key, $results, $metabib, $ignore) = @_;
1531 my $data = $cache->get_cache($key);
1534 return undef unless (@$results);
1536 # The query we're constructing
1538 # select mfae.field as id,
1540 # count(distinct mmrsm.appropriate-id-field )
1541 # from metabib.facet_entry mfae
1542 # join metabib.metarecord_sourc_map mmrsm on (mfae.source = mmrsm.source)
1543 # where mmrsm.appropriate-id-field in IDLIST
1546 my $count_field = $metabib ? 'metarecord' : 'source';
1549 mfae => [ { column => 'field', alias => 'id'}, 'value' ],
1551 transform => 'count',
1553 column => $count_field,
1560 mmrsm => { field => 'source', fkey => 'source' },
1561 cmf => { field => 'id', fkey => 'field' }
1565 '+mmrsm' => { $count_field => $results },
1566 '+cmf' => { facet_field => 't' }
1570 $query->{where}->{'+cmf'}->{field_class} = {'not in' => $ignore}
1571 if ref($ignore) and @$ignore > 0;
1573 my $facets = $U->cstorereq("open-ils.cstore.json_query.atomic", $query);
1575 for my $facet (@$facets) {
1576 next unless ($facet->{value});
1577 $data->{$facet->{id}}->{$facet->{value}} += $facet->{count};
1580 $logger->info("facet compilation: cached with key=$key");
1582 $cache->put_cache($key, $data, $cache_timeout);
1585 sub cache_staged_search_page {
1586 # puts this set of results into the cache
1587 my($key, $page, $summary, $results) = @_;
1588 my $data = $cache->get_cache($key);
1591 summary => $summary,
1595 $logger->info("staged search: cached with key=$key, superpage=$page, estimated=".
1596 $summary->{estimated_hit_count}.", visible=".$summary->{visible});
1598 $cache->put_cache($key, $data, $cache_timeout);
1606 my $start = $offset;
1607 my $end = $offset + $limit - 1;
1609 $logger->debug("searching cache for $key : $start..$end\n");
1611 return undef unless $cache;
1612 my $data = $cache->get_cache($key);
1614 return undef unless $data;
1616 my $count = $data->[0];
1619 return undef unless $offset < $count;
1622 for( my $i = $offset; $i <= $end; $i++ ) {
1623 last unless my $d = $$data[$i];
1624 push( @result, $d );
1627 $logger->debug("search_cache found ".scalar(@result)." items for count=$count, start=$start, end=$end");
1634 my( $key, $count, $data ) = @_;
1635 return undef unless $cache;
1636 $logger->debug("search_cache putting ".
1637 scalar(@$data)." items at key $key with timeout $cache_timeout");
1638 $cache->put_cache($key, [ $count, $data ], $cache_timeout);
1642 __PACKAGE__->register_method(
1643 method => "biblio_mrid_to_modsbatch_batch",
1644 api_name => "open-ils.search.biblio.metarecord.mods_slim.batch.retrieve"
1647 sub biblio_mrid_to_modsbatch_batch {
1648 my( $self, $client, $mrids) = @_;
1649 # warn "Performing mrid_to_modsbatch_batch..."; # unconditional warn
1651 my $method = $self->method_lookup("open-ils.search.biblio.metarecord.mods_slim.retrieve");
1652 for my $id (@$mrids) {
1653 next unless defined $id;
1654 my ($m) = $method->run($id);
1661 foreach (qw /open-ils.search.biblio.metarecord.mods_slim.retrieve
1662 open-ils.search.biblio.metarecord.mods_slim.retrieve.staff/)
1664 __PACKAGE__->register_method(
1665 method => "biblio_mrid_to_modsbatch",
1668 desc => "Returns the mvr associated with a given metarecod. If none exists, it is created. "
1669 . "As usual, the .staff version of this method will include otherwise hidden records.",
1671 { desc => 'Metarecord ID', type => 'number' },
1672 { desc => '(Optional) Search filters hash with possible keys: format, org, depth', type => 'object' }
1675 desc => 'MVR Object, event on error',
1681 sub biblio_mrid_to_modsbatch {
1682 my( $self, $client, $mrid, $args) = @_;
1684 # warn "Grabbing mvr for $mrid\n"; # unconditional warn
1686 my ($mr, $evt) = _grab_metarecord($mrid);
1687 return $evt unless $mr;
1689 my $mvr = biblio_mrid_check_mvr($self, $client, $mr) ||
1690 biblio_mrid_make_modsbatch($self, $client, $mr);
1692 return $mvr unless ref($args);
1694 # Here we find the lead record appropriate for the given filters
1695 # and use that for the title and author of the metarecord
1696 my $format = $$args{format};
1697 my $org = $$args{org};
1698 my $depth = $$args{depth};
1700 return $mvr unless $format or $org or $depth;
1702 my $method = "open-ils.storage.ordered.metabib.metarecord.records";
1703 $method = "$method.staff" if $self->api_name =~ /staff/o;
1705 my $rec = $U->storagereq($method, $format, $org, $depth, 1);
1707 if( my $mods = $U->record_to_mvr($rec) ) {
1709 $mvr->title( $mods->title );
1710 $mvr->author($mods->author);
1711 $logger->debug("mods_slim updating title and ".
1712 "author in mvr with ".$mods->title." : ".$mods->author);
1718 # converts a metarecord to an mvr
1721 my $perl = OpenSRF::Utils::JSON->JSON2perl($mr->mods());
1722 return Fieldmapper::metabib::virtual_record->new($perl);
1725 # checks to see if a metarecord has mods, if so returns true;
1727 __PACKAGE__->register_method(
1728 method => "biblio_mrid_check_mvr",
1729 api_name => "open-ils.search.biblio.metarecord.mods_slim.check",
1730 notes => "Takes a metarecord ID or a metarecord object and returns true "
1731 . "if the metarecord already has an mvr associated with it."
1734 sub biblio_mrid_check_mvr {
1735 my( $self, $client, $mrid ) = @_;
1739 if(ref($mrid)) { $mr = $mrid; }
1740 else { ($mr, $evt) = _grab_metarecord($mrid); }
1741 return $evt if $evt;
1743 # warn "Checking mvr for mr " . $mr->id . "\n"; # unconditional warn
1745 return _mr_to_mvr($mr) if $mr->mods();
1749 sub _grab_metarecord {
1751 #my $e = OpenILS::Utils::Editor->new;
1752 my $e = new_editor();
1753 my $mr = $e->retrieve_metabib_metarecord($mrid) or return ( undef, $e->event );
1758 __PACKAGE__->register_method(
1759 method => "biblio_mrid_make_modsbatch",
1760 api_name => "open-ils.search.biblio.metarecord.mods_slim.create",
1761 notes => "Takes either a metarecord ID or a metarecord object. "
1762 . "Forces the creations of an mvr for the given metarecord. "
1763 . "The created mvr is returned."
1766 sub biblio_mrid_make_modsbatch {
1767 my( $self, $client, $mrid ) = @_;
1769 #my $e = OpenILS::Utils::Editor->new;
1770 my $e = new_editor();
1777 $mr = $e->retrieve_metabib_metarecord($mrid)
1778 or return $e->event;
1781 my $masterid = $mr->master_record;
1782 $logger->info("creating new mods batch for metarecord=$mrid, master record=$masterid");
1784 my $ids = $U->storagereq(
1785 'open-ils.storage.ordered.metabib.metarecord.records.staff.atomic', $mrid);
1786 return undef unless @$ids;
1788 my $master = $e->retrieve_biblio_record_entry($masterid)
1789 or return $e->event;
1791 # start the mods batch
1792 my $u = OpenILS::Utils::ModsParser->new();
1793 $u->start_mods_batch( $master->marc );
1795 # grab all of the sub-records and shove them into the batch
1796 my @ids = grep { $_ ne $masterid } @$ids;
1797 #my $subrecs = (@ids) ? $e->batch_retrieve_biblio_record_entry(\@ids) : [];
1802 my $r = $e->retrieve_biblio_record_entry($i);
1803 push( @$subrecs, $r ) if $r;
1808 $logger->debug("adding record ".$_->id." to mods batch for metarecord=$mrid");
1809 $u->push_mods_batch( $_->marc ) if $_->marc;
1813 # finish up and send to the client
1814 my $mods = $u->finish_mods_batch();
1815 $mods->doc_id($mrid);
1816 $client->respond_complete($mods);
1819 # now update the mods string in the db
1820 my $string = OpenSRF::Utils::JSON->perl2JSON($mods->decast);
1823 #$e = OpenILS::Utils::Editor->new(xact => 1);
1824 $e = new_editor(xact => 1);
1825 $e->update_metabib_metarecord($mr)
1826 or $logger->error("Error setting mods text on metarecord $mrid : " . Dumper($e->event));
1833 # converts a mr id into a list of record ids
1835 foreach (qw/open-ils.search.biblio.metarecord_to_records
1836 open-ils.search.biblio.metarecord_to_records.staff/)
1838 __PACKAGE__->register_method(
1839 method => "biblio_mrid_to_record_ids",
1842 desc => "Fetch record IDs corresponding to a meta-record ID, with optional search filters. "
1843 . "As usual, the .staff version of this method will include otherwise hidden records.",
1845 { desc => 'Metarecord ID', type => 'number' },
1846 { desc => '(Optional) Search filters hash with possible keys: format, org, depth', type => 'object' }
1849 desc => 'Results object like {count => $i, ids =>[...]}',
1857 sub biblio_mrid_to_record_ids {
1858 my( $self, $client, $mrid, $args ) = @_;
1860 my $format = $$args{format};
1861 my $org = $$args{org};
1862 my $depth = $$args{depth};
1864 my $method = "open-ils.storage.ordered.metabib.metarecord.records.atomic";
1865 $method =~ s/atomic/staff\.atomic/o if $self->api_name =~ /staff/o;
1866 my $recs = $U->storagereq($method, $mrid, $format, $org, $depth);
1868 return { count => scalar(@$recs), ids => $recs };
1872 __PACKAGE__->register_method(
1873 method => "biblio_record_to_marc_html",
1874 api_name => "open-ils.search.biblio.record.html"
1877 __PACKAGE__->register_method(
1878 method => "biblio_record_to_marc_html",
1879 api_name => "open-ils.search.authority.to_html"
1882 # Persistent parsers and setting objects
1883 my $parser = XML::LibXML->new();
1884 my $xslt = XML::LibXSLT->new();
1886 my $slim_marc_sheet;
1887 my $settings_client = OpenSRF::Utils::SettingsClient->new();
1889 sub biblio_record_to_marc_html {
1890 my($self, $client, $recordid, $slim, $marcxml) = @_;
1893 my $dir = $settings_client->config_value("dirs", "xsl");
1896 unless($slim_marc_sheet) {
1897 my $xsl = $settings_client->config_value(
1898 "apps", "open-ils.search", "app_settings", 'marc_html_xsl_slim');
1900 $xsl = $parser->parse_file("$dir/$xsl");
1901 $slim_marc_sheet = $xslt->parse_stylesheet($xsl);
1904 $sheet = $slim_marc_sheet;
1908 unless($marc_sheet) {
1909 my $xsl_key = ($slim) ? 'marc_html_xsl_slim' : 'marc_html_xsl';
1910 my $xsl = $settings_client->config_value(
1911 "apps", "open-ils.search", "app_settings", 'marc_html_xsl');
1912 $xsl = $parser->parse_file("$dir/$xsl");
1913 $marc_sheet = $xslt->parse_stylesheet($xsl);
1915 $sheet = $marc_sheet;
1920 my $e = new_editor();
1921 if($self->api_name =~ /authority/) {
1922 $record = $e->retrieve_authority_record_entry($recordid)
1923 or return $e->event;
1925 $record = $e->retrieve_biblio_record_entry($recordid)
1926 or return $e->event;
1928 $marcxml = $record->marc;
1931 my $xmldoc = $parser->parse_string($marcxml);
1932 my $html = $sheet->transform($xmldoc);
1933 return $html->documentElement->toString();
1936 __PACKAGE__->register_method(
1937 method => "format_biblio_record_entry",
1938 api_name => "open-ils.search.biblio.record.print",
1940 desc => 'Returns a printable version of the specified bib record',
1942 { desc => 'Biblio record entry ID or array of IDs', type => 'number' },
1945 desc => q/An action_trigger.event object or error event./,
1950 __PACKAGE__->register_method(
1951 method => "format_biblio_record_entry",
1952 api_name => "open-ils.search.biblio.record.email",
1954 desc => 'Emails an A/T templated version of the specified bib records to the authorized user',
1956 { desc => 'Authentication token', type => 'string'},
1957 { desc => 'Biblio record entry ID or array of IDs', type => 'number' },
1960 desc => q/Undefined on success, otherwise an error event./,
1966 sub format_biblio_record_entry {
1967 my($self, $conn, $arg1, $arg2) = @_;
1969 my $for_print = ($self->api_name =~ /print/);
1970 my $for_email = ($self->api_name =~ /email/);
1972 my $e; my $auth; my $bib_id; my $context_org;
1976 $context_org = $arg2 || $U->get_org_tree->id;
1977 $e = new_editor(xact => 1);
1978 } elsif ($for_email) {
1981 $e = new_editor(authtoken => $auth, xact => 1);
1982 return $e->die_event unless $e->checkauth;
1983 $context_org = $e->requestor->home_ou;
1987 if (ref $bib_id ne 'ARRAY') {
1988 $bib_ids = [ $bib_id ];
1993 my $bucket = Fieldmapper::container::biblio_record_entry_bucket->new;
1994 $bucket->btype('temp');
1995 $bucket->name('format_biblio_record_entry ' . $U->create_uuid_string);
1997 $bucket->owner($e->requestor)
2001 my $bucket_obj = $e->create_container_biblio_record_entry_bucket($bucket);
2003 for my $id (@$bib_ids) {
2005 my $bib = $e->retrieve_biblio_record_entry([$id]) or return $e->die_event;
2007 my $bucket_entry = Fieldmapper::container::biblio_record_entry_bucket_item->new;
2008 $bucket_entry->target_biblio_record_entry($bib);
2009 $bucket_entry->bucket($bucket_obj->id);
2010 $e->create_container_biblio_record_entry_bucket_item($bucket_entry);
2017 return $U->fire_object_event(undef, 'biblio.format.record_entry.print', [ $bucket ], $context_org);
2019 } elsif ($for_email) {
2021 $U->create_events_for_hook('biblio.format.record_entry.email', $bucket, $context_org, undef, undef, 1);
2028 __PACKAGE__->register_method(
2029 method => "retrieve_all_copy_statuses",
2030 api_name => "open-ils.search.config.copy_status.retrieve.all"
2033 sub retrieve_all_copy_statuses {
2034 my( $self, $client ) = @_;
2035 return new_editor()->retrieve_all_config_copy_status();
2039 __PACKAGE__->register_method(
2040 method => "copy_counts_per_org",
2041 api_name => "open-ils.search.biblio.copy_counts.retrieve"
2044 __PACKAGE__->register_method(
2045 method => "copy_counts_per_org",
2046 api_name => "open-ils.search.biblio.copy_counts.retrieve.staff"
2049 sub copy_counts_per_org {
2050 my( $self, $client, $record_id ) = @_;
2052 warn "Retreiveing copy copy counts for record $record_id and method " . $self->api_name . "\n";
2054 my $method = "open-ils.storage.biblio.record_entry.global_copy_count.atomic";
2055 if($self->api_name =~ /staff/) { $method =~ s/atomic/staff\.atomic/; }
2057 my $counts = $apputils->simple_scalar_request(
2058 "open-ils.storage", $method, $record_id );
2060 $counts = [ sort {$a->[0] <=> $b->[0]} @$counts ];
2065 __PACKAGE__->register_method(
2066 method => "copy_count_summary",
2067 api_name => "open-ils.search.biblio.copy_counts.summary.retrieve",
2068 notes => "returns an array of these: "
2069 . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, <status1_count>, <status2_count>,...] "
2070 . "where statusx is a copy status name. The statuses are sorted by ID.",
2074 sub copy_count_summary {
2075 my( $self, $client, $rid, $org, $depth ) = @_;
2078 my $data = $U->storagereq(
2079 'open-ils.storage.biblio.record_entry.status_copy_count.atomic', $rid, $org, $depth );
2082 (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2084 (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2088 __PACKAGE__->register_method(
2089 method => "copy_location_count_summary",
2090 api_name => "open-ils.search.biblio.copy_location_counts.summary.retrieve",
2091 notes => "returns an array of these: "
2092 . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, copy_location, <status1_count>, <status2_count>,...] "
2093 . "where statusx is a copy status name. The statuses are sorted by ID.",
2096 sub copy_location_count_summary {
2097 my( $self, $client, $rid, $org, $depth ) = @_;
2100 my $data = $U->storagereq(
2101 'open-ils.storage.biblio.record_entry.status_copy_location_count.atomic', $rid, $org, $depth );
2104 (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2106 (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2108 || $a->[4] cmp $b->[4]
2112 __PACKAGE__->register_method(
2113 method => "copy_count_location_summary",
2114 api_name => "open-ils.search.biblio.copy_counts.location.summary.retrieve",
2115 notes => "returns an array of these: "
2116 . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, <status1_count>, <status2_count>,...] "
2117 . "where statusx is a copy status name. The statuses are sorted by ID."
2120 sub copy_count_location_summary {
2121 my( $self, $client, $rid, $org, $depth ) = @_;
2124 my $data = $U->storagereq(
2125 'open-ils.storage.biblio.record_entry.status_copy_location_count.atomic', $rid, $org, $depth );
2127 (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2129 (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2134 foreach (qw/open-ils.search.biblio.marc
2135 open-ils.search.biblio.marc.staff/)
2137 __PACKAGE__->register_method(
2138 method => "marc_search",
2141 desc => 'Fetch biblio IDs based on MARC record criteria. '
2142 . 'As usual, the .staff version of the search includes otherwise hidden records',
2145 desc => 'Search hash (required) with possible elements: searches, limit, offset, sort, sort_dir. ' .
2146 'See perldoc ' . __PACKAGE__ . ' for more detail.',
2149 {desc => 'limit (optional)', type => 'number'},
2150 {desc => 'offset (optional)', type => 'number'}
2153 desc => 'Results object like: { "count": $i, "ids": [...] }',
2160 =head3 open-ils.search.biblio.marc (arghash, limit, offset)
2162 As elsewhere the arghash is the required argument, and must be a hashref. The keys are:
2164 searches: complex query object (required)
2165 org_unit: The org ID to focus the search at
2166 depth : The org depth
2167 limit : integer search limit default: 10
2168 offset : integer search offset default: 0
2169 sort : What field to sort the results on? [ author | title | pubdate ]
2170 sort_dir: In what direction do we sort? [ asc | desc ]
2172 Additional keys to refine search criteria:
2175 language : Language (code)
2176 lit_form : Literary form
2177 item_form: Item form
2178 item_type: Item type
2179 format : The MARC format
2181 Please note that the specific strings to be used in the "addtional keys" will be entirely
2182 dependent on your loaded data.
2184 All keys except "searches" are optional.
2185 The "searches" value must be an arrayref of hashref elements, including keys "term" and "restrict".
2187 For example, an arg hash might look like:
2209 The arghash is eventually passed to the SRF call:
2210 L<open-ils.storage.biblio.full_rec.multi_search[.staff].atomic>
2212 Presently, search uses the cache unconditionally.
2216 # FIXME: that example above isn't actually tested.
2217 # TODO: docache option?
2219 my( $self, $conn, $args, $limit, $offset, $timeout ) = @_;
2221 my $method = 'open-ils.storage.biblio.full_rec.multi_search';
2222 $method .= ".staff" if $self->api_name =~ /staff/;
2223 $method .= ".atomic";
2225 $limit ||= 10; # FIXME: what about $args->{limit} ?
2226 $offset ||= 0; # FIXME: what about $args->{offset} ?
2228 # allow caller to pass in a call timeout since MARC searches
2229 # can take longer than the default 60-second timeout.
2230 # Default to 2 mins. Arbitrarily cap at 5 mins.
2231 $timeout = 120 if !$timeout or $timeout > 300;
2234 push( @search, ($_ => $$args{$_}) ) for (sort keys %$args);
2235 my $ckey = $pfx . md5_hex($method . OpenSRF::Utils::JSON->perl2JSON(\@search));
2237 my $recs = search_cache($ckey, $offset, $limit);
2241 my $ses = OpenSRF::AppSession->create('open-ils.storage');
2242 my $req = $ses->request($method, %$args);
2243 my $resp = $req->recv($timeout);
2245 if($resp and $recs = $resp->content) {
2246 put_cache($ckey, scalar(@$recs), $recs);
2247 $recs = [ @$recs[$offset..($offset + ($limit - 1))] ];
2256 $count = $recs->[0]->[2] if $recs->[0] and $recs->[0]->[2];
2257 my @recs = map { $_->[0] } @$recs;
2259 return { ids => \@recs, count => $count };
2263 foreach my $isbn_method (qw/
2264 open-ils.search.biblio.isbn
2265 open-ils.search.biblio.isbn.staff
2267 __PACKAGE__->register_method(
2268 method => "biblio_search_isbn",
2269 api_name => $isbn_method,
2271 desc => 'Retrieve biblio IDs for a given ISBN. The .staff version of the call includes otherwise hidden hits.',
2273 {desc => 'ISBN', type => 'string'}
2276 desc => 'Results object like: { "count": $i, "ids": [...] }',
2283 sub biblio_search_isbn {
2284 my( $self, $client, $isbn ) = @_;
2285 $logger->debug("Searching ISBN $isbn");
2286 # the previous implementation of this method was essentially unlimited,
2287 # so we will set our limit very high and let multiclass.query provide any
2289 # XXX: if making this unlimited is deemed important, we might consider
2290 # reworking 'open-ils.storage.id_list.biblio.record_entry.search.isbn',
2291 # which is functionally deprecated at this point, or a custom call to
2292 # 'open-ils.storage.biblio.multiclass.search_fts'
2294 my $isbn_method = 'open-ils.search.biblio.multiclass.query';
2295 if ($self->api_name =~ m/.staff$/) {
2296 $isbn_method .= '.staff';
2299 my $method = $self->method_lookup($isbn_method);
2300 my ($search_result) = $method->run({'limit' => 1000000}, "identifier|isbn:$isbn");
2301 my @recs = map { $_->[0] } @{$search_result->{'ids'}};
2302 return { ids => \@recs, count => $search_result->{'count'} };
2305 __PACKAGE__->register_method(
2306 method => "biblio_search_isbn_batch",
2307 api_name => "open-ils.search.biblio.isbn_list",
2310 # XXX: see biblio_search_isbn() for note concerning 'limit'
2311 sub biblio_search_isbn_batch {
2312 my( $self, $client, $isbn_list ) = @_;
2313 $logger->debug("Searching ISBNs @$isbn_list");
2314 my @recs = (); my %rec_set = ();
2315 my $method = $self->method_lookup('open-ils.search.biblio.multiclass.query');
2316 foreach my $isbn ( @$isbn_list ) {
2317 my ($search_result) = $method->run({'limit' => 1000000}, "identifier|isbn:$isbn");
2318 my @recs_subset = map { $_->[0] } @{$search_result->{'ids'}};
2319 foreach my $rec (@recs_subset) {
2320 if (! $rec_set{ $rec }) {
2321 $rec_set{ $rec } = 1;
2326 return { ids => \@recs, count => scalar(@recs) };
2329 foreach my $issn_method (qw/
2330 open-ils.search.biblio.issn
2331 open-ils.search.biblio.issn.staff
2333 __PACKAGE__->register_method(
2334 method => "biblio_search_issn",
2335 api_name => $issn_method,
2337 desc => 'Retrieve biblio IDs for a given ISSN',
2339 {desc => 'ISBN', type => 'string'}
2342 desc => 'Results object like: { "count": $i, "ids": [...] }',
2349 sub biblio_search_issn {
2350 my( $self, $client, $issn ) = @_;
2351 $logger->debug("Searching ISSN $issn");
2352 # the previous implementation of this method was essentially unlimited,
2353 # so we will set our limit very high and let multiclass.query provide any
2355 # XXX: if making this unlimited is deemed important, we might consider
2356 # reworking 'open-ils.storage.id_list.biblio.record_entry.search.issn',
2357 # which is functionally deprecated at this point, or a custom call to
2358 # 'open-ils.storage.biblio.multiclass.search_fts'
2360 my $issn_method = 'open-ils.search.biblio.multiclass.query';
2361 if ($self->api_name =~ m/.staff$/) {
2362 $issn_method .= '.staff';
2365 my $method = $self->method_lookup($issn_method);
2366 my ($search_result) = $method->run({'limit' => 1000000}, "identifier|issn:$issn");
2367 my @recs = map { $_->[0] } @{$search_result->{'ids'}};
2368 return { ids => \@recs, count => $search_result->{'count'} };
2372 __PACKAGE__->register_method(
2373 method => "fetch_mods_by_copy",
2374 api_name => "open-ils.search.biblio.mods_from_copy",
2377 desc => 'Retrieve MODS record given an attached copy ID',
2379 { desc => 'Copy ID', type => 'number' }
2382 desc => 'MODS record, event on error or uncataloged item'
2387 sub fetch_mods_by_copy {
2388 my( $self, $client, $copyid ) = @_;
2389 my ($record, $evt) = $apputils->fetch_record_by_copy( $copyid );
2390 return $evt if $evt;
2391 return OpenILS::Event->new('ITEM_NOT_CATALOGED') unless $record->marc;
2392 return $apputils->record_to_mvr($record);
2396 # -------------------------------------------------------------------------------------
2398 __PACKAGE__->register_method(
2399 method => "cn_browse",
2400 api_name => "open-ils.search.callnumber.browse.target",
2401 notes => "Starts a callnumber browse"
2404 __PACKAGE__->register_method(
2405 method => "cn_browse",
2406 api_name => "open-ils.search.callnumber.browse.page_up",
2407 notes => "Returns the previous page of callnumbers",
2410 __PACKAGE__->register_method(
2411 method => "cn_browse",
2412 api_name => "open-ils.search.callnumber.browse.page_down",
2413 notes => "Returns the next page of callnumbers",
2417 # RETURNS array of arrays like so: label, owning_lib, record, id
2419 my( $self, $client, @params ) = @_;
2422 $method = 'open-ils.storage.asset.call_number.browse.target.atomic'
2423 if( $self->api_name =~ /target/ );
2424 $method = 'open-ils.storage.asset.call_number.browse.page_up.atomic'
2425 if( $self->api_name =~ /page_up/ );
2426 $method = 'open-ils.storage.asset.call_number.browse.page_down.atomic'
2427 if( $self->api_name =~ /page_down/ );
2429 return $apputils->simplereq( 'open-ils.storage', $method, @params );
2431 # -------------------------------------------------------------------------------------
2433 __PACKAGE__->register_method(
2434 method => "fetch_cn",
2435 api_name => "open-ils.search.callnumber.retrieve",
2437 notes => "retrieves a callnumber based on ID",
2441 my( $self, $client, $id ) = @_;
2443 my $e = new_editor();
2444 my( $cn, $evt ) = $apputils->fetch_callnumber( $id, 0, $e );
2445 return $evt if $evt;
2449 __PACKAGE__->register_method(
2450 method => "fetch_fleshed_cn",
2451 api_name => "open-ils.search.callnumber.fleshed.retrieve",
2453 notes => "retrieves a callnumber based on ID, fleshing prefix, suffix, and label_class",
2456 sub fetch_fleshed_cn {
2457 my( $self, $client, $id ) = @_;
2459 my $e = new_editor();
2460 my( $cn, $evt ) = $apputils->fetch_callnumber( $id, 1, $e );
2461 return $evt if $evt;
2466 __PACKAGE__->register_method(
2467 method => "fetch_copy_by_cn",
2468 api_name => 'open-ils.search.copies_by_call_number.retrieve',
2470 Returns an array of copy ID's by callnumber ID
2471 @param cnid The callnumber ID
2472 @return An array of copy IDs
2476 sub fetch_copy_by_cn {
2477 my( $self, $conn, $cnid ) = @_;
2478 return $U->cstorereq(
2479 'open-ils.cstore.direct.asset.copy.id_list.atomic',
2480 { call_number => $cnid, deleted => 'f' } );
2483 __PACKAGE__->register_method(
2484 method => 'fetch_cn_by_info',
2485 api_name => 'open-ils.search.call_number.retrieve_by_info',
2487 @param label The callnumber label
2488 @param record The record the cn is attached to
2489 @param org The owning library of the cn
2490 @return The callnumber object
2495 sub fetch_cn_by_info {
2496 my( $self, $conn, $label, $record, $org ) = @_;
2497 return $U->cstorereq(
2498 'open-ils.cstore.direct.asset.call_number.search',
2499 { label => $label, record => $record, owning_lib => $org, deleted => 'f' });
2504 __PACKAGE__->register_method(
2505 method => 'bib_extras',
2506 api_name => 'open-ils.search.biblio.lit_form_map.retrieve.all',
2509 __PACKAGE__->register_method(
2510 method => 'bib_extras',
2511 api_name => 'open-ils.search.biblio.item_form_map.retrieve.all',
2512 ctype => 'item_form'
2514 __PACKAGE__->register_method(
2515 method => 'bib_extras',
2516 api_name => 'open-ils.search.biblio.item_type_map.retrieve.all',
2517 ctype => 'item_type',
2519 __PACKAGE__->register_method(
2520 method => 'bib_extras',
2521 api_name => 'open-ils.search.biblio.bib_level_map.retrieve.all',
2522 ctype => 'bib_level'
2524 __PACKAGE__->register_method(
2525 method => 'bib_extras',
2526 api_name => 'open-ils.search.biblio.audience_map.retrieve.all',
2532 $logger->warn("deprecation warning: " .$self->api_name);
2534 my $e = new_editor();
2536 my $ctype = $self->{ctype};
2537 my $ccvms = $e->search_config_coded_value_map({ctype => $ctype});
2540 for my $ccvm (@$ccvms) {
2541 my $obj = "Fieldmapper::config::${ctype}_map"->new;
2542 $obj->value($ccvm->value);
2543 $obj->code($ccvm->code);
2544 $obj->description($ccvm->description) if $obj->can('description');
2553 __PACKAGE__->register_method(
2554 method => 'fetch_slim_record',
2555 api_name => 'open-ils.search.biblio.record_entry.slim.retrieve',
2557 desc => "Retrieves one or more biblio.record_entry without the attached marcxml",
2559 { desc => 'Array of Record IDs', type => 'array' }
2562 desc => 'Array of biblio records, event on error'
2567 sub fetch_slim_record {
2568 my( $self, $conn, $ids ) = @_;
2570 #my $editor = OpenILS::Utils::Editor->new;
2571 my $editor = new_editor();
2574 return $editor->event unless
2575 my $r = $editor->retrieve_biblio_record_entry($_);
2582 __PACKAGE__->register_method(
2583 method => 'rec_hold_parts',
2584 api_name => 'open-ils.search.biblio.record_hold_parts',
2586 Returns a list of {label :foo, id : bar} objects for viable monograph parts for a given record
2590 sub rec_hold_parts {
2591 my( $self, $conn, $args ) = @_;
2593 my $rec = $$args{record};
2594 my $mrec = $$args{metarecord};
2595 my $pickup_lib = $$args{pickup_lib};
2596 my $e = new_editor();
2599 select => {bmp => ['id', 'label']},
2604 select => {'acpm' => ['part']},
2605 from => {acpm => {acp => {join => {acn => {join => 'bre'}}}}},
2607 '+acp' => {'deleted' => 'f'},
2608 '+bre' => {id => $rec}
2614 order_by =>[{class=>'bmp', field=>'label_sortkey'}]
2617 if(defined $pickup_lib) {
2618 my $hard_boundary = $U->ou_ancestor_setting_value($pickup_lib, OILS_SETTING_HOLD_HARD_BOUNDARY);
2619 if($hard_boundary) {
2620 my $orgs = $e->json_query({from => ['actor.org_unit_descendants' => $pickup_lib, $hard_boundary]});
2621 $query->{where}->{'+acp'}->{circ_lib} = [ map { $_->{id} } @$orgs ];
2625 return $e->json_query($query);
2631 __PACKAGE__->register_method(
2632 method => 'rec_to_mr_rec_descriptors',
2633 api_name => 'open-ils.search.metabib.record_to_descriptors',
2635 specialized method...
2636 Given a biblio record id or a metarecord id,
2637 this returns a list of metabib.record_descriptor
2638 objects that live within the same metarecord
2639 @param args Object of args including:
2643 sub rec_to_mr_rec_descriptors {
2644 my( $self, $conn, $args ) = @_;
2646 my $rec = $$args{record};
2647 my $mrec = $$args{metarecord};
2648 my $item_forms = $$args{item_forms};
2649 my $item_types = $$args{item_types};
2650 my $item_lang = $$args{item_lang};
2651 my $pickup_lib = $$args{pickup_lib};
2653 my $hard_boundary = $U->ou_ancestor_setting_value($pickup_lib, OILS_SETTING_HOLD_HARD_BOUNDARY) if (defined $pickup_lib);
2655 my $e = new_editor();
2659 my $map = $e->search_metabib_metarecord_source_map({source => $rec});
2660 return $e->event unless @$map;
2661 $mrec = $$map[0]->metarecord;
2664 $recs = $e->search_metabib_metarecord_source_map({metarecord => $mrec});
2665 return $e->event unless @$recs;
2667 my @recs = map { $_->source } @$recs;
2668 my $search = { record => \@recs };
2669 $search->{item_form} = $item_forms if $item_forms and @$item_forms;
2670 $search->{item_type} = $item_types if $item_types and @$item_types;
2671 $search->{item_lang} = $item_lang if $item_lang;
2673 my $desc = $e->search_metabib_record_descriptor($search);
2677 select => { 'bre' => ['id'] },
2682 'acp' => {"join" => {"acpl" => {}, "ccs" => {}}}
2688 '+bre' => { id => \@recs },
2693 "+ccs" => { holdable => 't' },
2694 "+acpl" => { holdable => 't' }
2698 if ($hard_boundary) { # 0 (or "top") is the same as no setting
2699 my $orgs = $e->json_query(
2700 { from => [ 'actor.org_unit_descendants' => $pickup_lib, $hard_boundary ] }
2701 ) or return $e->die_event;
2703 $query->{where}->{"+acp"}->{circ_lib} = [ map { $_->{id} } @$orgs ];
2706 my $good_records = $e->json_query($query) or return $e->die_event;
2709 for my $d (@$desc) {
2710 if ( grep { $d->record == $_->{id} } @$good_records ) {
2717 return { metarecord => $mrec, descriptors => $desc };
2721 __PACKAGE__->register_method(
2722 method => 'fetch_age_protect',
2723 api_name => 'open-ils.search.copy.age_protect.retrieve.all',
2726 sub fetch_age_protect {
2727 return new_editor()->retrieve_all_config_rule_age_hold_protect();
2731 __PACKAGE__->register_method(
2732 method => 'copies_by_cn_label',
2733 api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label',
2736 __PACKAGE__->register_method(
2737 method => 'copies_by_cn_label',
2738 api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label.staff',
2741 sub copies_by_cn_label {
2742 my( $self, $conn, $record, $cn_parts, $circ_lib ) = @_;
2743 my $e = new_editor();
2744 my $cnp_id = $cn_parts->[0] eq '' ? -1 : $e->search_asset_call_number_prefix({label => $cn_parts->[0]}, {idlist=>1})->[0];
2745 my $cns_id = $cn_parts->[2] eq '' ? -1 : $e->search_asset_call_number_suffix({label => $cn_parts->[2]}, {idlist=>1})->[0];
2746 my $cns = $e->search_asset_call_number({record => $record, prefix => $cnp_id, label => $cn_parts->[1], suffix => $cns_id, deleted => 'f'}, {idlist=>1});
2747 return [] unless @$cns;
2749 # show all non-deleted copies in the staff client ...
2750 if ($self->api_name =~ /staff$/o) {
2751 return $e->search_asset_copy({call_number => $cns, circ_lib => $circ_lib, deleted => 'f'}, {idlist=>1});
2754 # ... otherwise, grab the copies ...
2755 my $copies = $e->search_asset_copy(
2756 [ {call_number => $cns, circ_lib => $circ_lib, deleted => 'f', opac_visible => 't'},
2757 {flesh => 1, flesh_fields => { acp => [ qw/location status/] } }
2761 # ... and test for location and status visibility
2762 return [ map { ($U->is_true($_->location->opac_visible) && $U->is_true($_->status->opac_visible)) ? ($_->id) : () } @$copies ];