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();
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",
93 note => "Provide ID, we provide the mods"
96 # converts a record into a mods object with copy counts attached
97 sub record_id_to_mods {
99 my( $self, $client, $org_id, $id ) = @_;
101 my $mods_list = _records_to_mods( $id );
102 my $mods_obj = $mods_list->[0];
103 my $cmethod = $self->method_lookup(
104 "open-ils.search.biblio.record.copy_count");
105 my ($count) = $cmethod->run($org_id, $id);
106 $mods_obj->copy_count($count);
113 __PACKAGE__->register_method(
114 method => "record_id_to_mods_slim",
116 api_name => "open-ils.search.biblio.record.mods_slim.retrieve",
118 note => "Provide ID, we provide the mods"
121 # converts a record into a mods object with NO copy counts attached
122 sub record_id_to_mods_slim {
123 my( $self, $client, $id ) = @_;
124 return undef unless defined $id;
126 if(ref($id) and ref($id) == 'ARRAY') {
127 return _records_to_mods( @$id );
129 my $mods_list = _records_to_mods( $id );
130 my $mods_obj = $mods_list->[0];
131 return OpenILS::Event->new('BIBLIO_RECORD_ENTRY_NOT_FOUND') unless $mods_obj;
136 # Returns the number of copies attached to a record based on org location
137 __PACKAGE__->register_method(
138 method => "record_id_to_copy_count",
139 api_name => "open-ils.search.biblio.record.copy_count",
142 __PACKAGE__->register_method(
143 method => "record_id_to_copy_count",
145 api_name => "open-ils.search.biblio.record.copy_count.staff",
148 __PACKAGE__->register_method(
149 method => "record_id_to_copy_count",
150 api_name => "open-ils.search.biblio.metarecord.copy_count",
153 __PACKAGE__->register_method(
154 method => "record_id_to_copy_count",
155 api_name => "open-ils.search.biblio.metarecord.copy_count.staff",
157 sub record_id_to_copy_count {
158 my( $self, $client, $org_id, $record_id, $format ) = @_;
160 return [] unless $record_id;
161 $format = undef if (!$format or $format eq 'all');
163 my $method = "open-ils.storage.biblio.record_entry.copy_count.atomic";
166 if($self->api_name =~ /metarecord/) {
167 $method = "open-ils.storage.metabib.metarecord.copy_count.atomic";
171 $method =~ s/atomic/staff\.atomic/og if($self->api_name =~ /staff/ );
173 my $count = $U->storagereq( $method,
174 org_unit => $org_id, $key => $record_id, format => $format );
176 return [ sort { $a->{depth} <=> $b->{depth} } @$count ];
182 __PACKAGE__->register_method(
183 method => "biblio_search_tcn",
184 api_name => "open-ils.search.biblio.tcn",
186 note => "Retrieve a record by TCN",
189 sub biblio_search_tcn {
191 my( $self, $client, $tcn, $include_deleted ) = @_;
193 $tcn =~ s/.*?(\w+)\s*$/$1/o;
195 my $e = new_editor();
196 my $search = {tcn_value => $tcn};
197 $search->{deleted} = 'f' unless $include_deleted;
198 my $recs = $e->search_biblio_record_entry( $search, {idlist =>1} );
200 return { count => scalar(@$recs), ids => $recs };
204 # --------------------------------------------------------------------------------
206 __PACKAGE__->register_method(
207 method => "biblio_barcode_to_copy",
208 api_name => "open-ils.search.asset.copy.find_by_barcode",);
209 sub biblio_barcode_to_copy {
210 my( $self, $client, $barcode ) = @_;
211 my( $copy, $evt ) = $U->fetch_copy_by_barcode($barcode);
216 __PACKAGE__->register_method(
217 method => "biblio_id_to_copy",
218 api_name => "open-ils.search.asset.copy.batch.retrieve",);
219 sub biblio_id_to_copy {
220 my( $self, $client, $ids ) = @_;
221 $logger->info("Fetching copies @$ids");
222 return $U->cstorereq(
223 "open-ils.cstore.direct.asset.copy.search.atomic", { id => $ids } );
227 __PACKAGE__->register_method(
228 method => "copy_retrieve",
229 api_name => "open-ils.search.asset.copy.retrieve",);
231 my( $self, $client, $cid ) = @_;
232 my( $copy, $evt ) = $U->fetch_copy($cid);
237 __PACKAGE__->register_method(
238 method => "volume_retrieve",
239 api_name => "open-ils.search.asset.call_number.retrieve");
240 sub volume_retrieve {
241 my( $self, $client, $vid ) = @_;
242 my $e = new_editor();
243 my $vol = $e->retrieve_asset_call_number($vid) or return $e->event;
247 __PACKAGE__->register_method(
248 method => "fleshed_copy_retrieve_batch",
250 api_name => "open-ils.search.asset.copy.fleshed.batch.retrieve");
252 sub fleshed_copy_retrieve_batch {
253 my( $self, $client, $ids ) = @_;
254 $logger->info("Fetching fleshed copies @$ids");
255 return $U->cstorereq(
256 "open-ils.cstore.direct.asset.copy.search.atomic",
259 flesh_fields => { acp => [ qw/ circ_lib location status stat_cat_entries / ] }
264 __PACKAGE__->register_method(
265 method => "fleshed_copy_retrieve",
266 api_name => "open-ils.search.asset.copy.fleshed.retrieve",);
268 sub fleshed_copy_retrieve {
269 my( $self, $client, $id ) = @_;
270 my( $c, $e) = $U->fetch_fleshed_copy($id);
277 __PACKAGE__->register_method(
278 method => 'fleshed_by_barcode',
279 api_name => "open-ils.search.asset.copy.fleshed2.find_by_barcode",);
280 sub fleshed_by_barcode {
281 my( $self, $conn, $barcode ) = @_;
282 my $e = new_editor();
283 my $copyid = $e->search_asset_copy(
284 {barcode => $barcode, deleted => 'f'}, {idlist=>1})->[0]
286 return fleshed_copy_retrieve2( $self, $conn, $copyid);
290 __PACKAGE__->register_method(
291 method => "fleshed_copy_retrieve2",
292 api_name => "open-ils.search.asset.copy.fleshed2.retrieve",);
294 sub fleshed_copy_retrieve2 {
295 my( $self, $client, $id ) = @_;
296 my $e = new_editor();
297 my $copy = $e->retrieve_asset_copy(
303 acp => [ qw/ location status stat_cat_entry_copy_maps notes age_protect / ],
304 ascecm => [ qw/ stat_cat stat_cat_entry / ],
308 ) or return $e->event;
310 # For backwards compatibility
311 #$copy->stat_cat_entries($copy->stat_cat_entry_copy_maps);
313 if( $copy->status->id == OILS_COPY_STATUS_CHECKED_OUT ) {
315 $e->search_action_circulation(
317 { target_copy => $copy->id },
319 order_by => { circ => 'xact_start desc' },
331 __PACKAGE__->register_method(
332 method => 'flesh_copy_custom',
333 api_name => 'open-ils.search.asset.copy.fleshed.custom'
336 sub flesh_copy_custom {
337 my( $self, $conn, $copyid, $fields ) = @_;
338 my $e = new_editor();
339 my $copy = $e->retrieve_asset_copy(
349 ) or return $e->event;
358 __PACKAGE__->register_method(
359 method => "biblio_barcode_to_title",
360 api_name => "open-ils.search.biblio.find_by_barcode",
363 sub biblio_barcode_to_title {
364 my( $self, $client, $barcode ) = @_;
366 my $title = $apputils->simple_scalar_request(
368 "open-ils.storage.biblio.record_entry.retrieve_by_barcode", $barcode );
370 return { ids => [ $title->id ], count => 1 } if $title;
371 return { count => 0 };
374 __PACKAGE__->register_method(
375 method => 'title_id_by_item_barcode',
376 api_name => 'open-ils.search.bib_id.by_barcode'
379 sub title_id_by_item_barcode {
380 my( $self, $conn, $barcode ) = @_;
381 my $e = new_editor();
382 my $copies = $e->search_asset_copy(
384 { deleted => 'f', barcode => $barcode },
388 acp => [ 'call_number' ],
395 return $e->event unless @$copies;
396 return $$copies[0]->call_number->record->id;
400 __PACKAGE__->register_method(
401 method => "biblio_copy_to_mods",
402 api_name => "open-ils.search.biblio.copy.mods.retrieve",
405 # takes a copy object and returns it fleshed mods object
406 sub biblio_copy_to_mods {
407 my( $self, $client, $copy ) = @_;
409 my $volume = $U->cstorereq(
410 "open-ils.cstore.direct.asset.call_number.retrieve",
411 $copy->call_number() );
413 my $mods = _records_to_mods($volume->record());
414 $mods = shift @$mods;
415 $volume->copies([$copy]);
416 push @{$mods->call_numbers()}, $volume;
422 __PACKAGE__->register_method(
423 api_name => 'open-ils.search.biblio.multiclass.query',
424 method => 'multiclass_query',
426 @param arghash @see open-ils.search.biblio.multiclass
427 @param query Raw human-readable query string.
428 Recognized search keys include:
429 keyword/kw - search keyword(s)
430 author/au/name - search author(s)
431 title/ti - search title
432 subject/su - search subject
433 series/se - search series
434 lang - limit by language (specifiy multiple langs with lang:l1 lang:l2 ...)
435 site - search at specified org unit, corresponds to actor.org_unit.shortname
436 sort - sort type (title, author, pubdate)
437 dir - sort direction (asc, desc)
438 available - if set to anything other than "false" or "0", limits to available items
440 keyword, title, author, subject, and series support additional search
441 subclasses, specified with a "|". For example, "title|proper:gone with the wind"
442 For more, see config.metabib_field
444 @param docache @see open-ils.search.biblio.multiclass
447 __PACKAGE__->register_method(
448 api_name => 'open-ils.search.biblio.multiclass.query.staff',
449 method => 'multiclass_query',
450 signature => '@see open-ils.search.biblio.multiclass.query');
451 __PACKAGE__->register_method(
452 api_name => 'open-ils.search.metabib.multiclass.query',
453 method => 'multiclass_query',
454 signature => '@see open-ils.search.biblio.multiclass.query');
455 __PACKAGE__->register_method(
456 api_name => 'open-ils.search.metabib.multiclass.query.staff',
457 method => 'multiclass_query',
458 signature => '@see open-ils.search.biblio.multiclass.query');
460 sub multiclass_query {
461 my($self, $conn, $arghash, $query, $docache) = @_;
463 $logger->debug("initial search query => $query");
464 my $orig_query = $query;
468 $query =~ s/^\s+//go;
470 # convert convenience classes (e.g. kw for keyword) to the full class name
471 $query =~ s/kw(:|\|)/keyword$1/go;
472 $query =~ s/ti(:|\|)/title$1/go;
473 $query =~ s/au(:|\|)/author$1/go;
474 $query =~ s/su(:|\|)/subject$1/go;
475 $query =~ s/se(:|\|)/series$1/go;
476 $query =~ s/name(:|\|)/author$1/og;
478 $logger->debug("cleansed query string => $query");
479 my $search = $arghash->{searches} = {};
481 while ($query =~ s/((?:keyword(?:\|\w+)?|title(?:\|\w+)?|author(?:\|\w+)?|subject(?:\|\w+)?|series(?:\|\w+)?|site|dir|sort|lang|available):[^:]+)$//so) {
482 my($type, $value) = split(':', $1);
483 next unless $type and $value;
485 $value =~ s/^\s*//og;
486 $value =~ s/\s*$//og;
487 $type = 'sort_dir' if $type eq 'dir';
489 if($type eq 'site') {
490 # 'site' is the org shortname. when using this, we also want
491 # to search at the requested org's depth
492 my $e = new_editor();
493 if(my $org = $e->search_actor_org_unit({shortname => $value})->[0]) {
494 $arghash->{org_unit} = $org->id if $org;
495 $arghash->{depth} = $e->retrieve_actor_org_unit_type($org->ou_type)->depth;
497 $logger->warn("'site:' query used on invalid org shortname: $value ... ignoring");
500 } elsif($type eq 'available') {
502 $arghash->{available} = 1 unless $value eq 'false' or $value eq '0';
504 } elsif($type eq 'lang') {
505 # collect languages into an array of languages
506 $arghash->{language} = [] unless $arghash->{language};
507 push(@{$arghash->{language}}, $value);
509 } elsif($type =~ /^sort/o) {
510 # sort and sort_dir modifiers
511 $arghash->{$type} = $value;
514 # append the search term to the term under construction
515 $search->{$type} = {} unless $search->{$type};
516 $search->{$type}->{term} =
517 ($search->{$type}->{term}) ? $search->{$type}->{term} . " $value" : $value;
522 # This is the front part of the string before any special tokens were parsed.
523 # Add this data to the default search class
524 my $type = $arghash->{default_class} || 'keyword';
525 $search->{$type} = {} unless $search->{$type};
526 $search->{$type}->{term} =
527 ($search->{$type}->{term}) ? $search->{$type}->{term} . " $query" : $query;
530 # capture the original limit because the search method alters the limit internally
531 my $ol = $arghash->{limit};
533 my $sclient = OpenSRF::Utils::SettingsClient->new;
535 (my $method = $self->api_name) =~ s/\.query//o;
537 $method =~ s/multiclass/multiclass.staged/
538 if $sclient->config_value(apps => 'open-ils.search',
539 app_settings => 'use_staged_search') =~ /true/i;
542 $method = $self->method_lookup($method);
543 my ($data) = $method->run($arghash, $docache);
545 $arghash->{limit} = $ol if $ol;
546 $data->{compiled_search} = $arghash;
547 $data->{query} = $orig_query;
549 $logger->info("compiled search is " . OpenSRF::Utils::JSON->perl2JSON($arghash));
554 __PACKAGE__->register_method(
555 method => 'cat_search_z_style_wrapper',
556 api_name => 'open-ils.search.biblio.zstyle',
558 signature => q/@see open-ils.search.biblio.multiclass/);
560 sub cat_search_z_style_wrapper {
563 my $authtoken = shift;
566 my $cstore = OpenSRF::AppSession->connect('open-ils.cstore');
568 my $ou = $cstore->request(
569 'open-ils.cstore.direct.actor.org_unit.search',
570 { parent_ou => undef }
573 my $result = { service => 'native-evergreen-catalog', records => [] };
574 my $searchhash = { limit => $$args{limit}, offset => $$args{offset}, org_unit => $ou->id };
576 $$searchhash{searches}{title}{term} = $$args{search}{title} if $$args{search}{title};
577 $$searchhash{searches}{author}{term} = $$args{search}{author} if $$args{search}{author};
578 $$searchhash{searches}{subject}{term} = $$args{search}{subject} if $$args{search}{subject};
579 $$searchhash{searches}{keyword}{term} = $$args{search}{keyword} if $$args{search}{keyword};
581 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{tcn} if $$args{search}{tcn};
582 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{isbn} if $$args{search}{isbn};
583 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{issn} if $$args{search}{issn};
584 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{publisher} if $$args{search}{publisher};
585 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{pubdate} if $$args{search}{pubdate};
586 $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{item_type} if $$args{search}{item_type};
588 my $list = the_quest_for_knowledge( $self, $client, $searchhash );
590 if ($list->{count} > 0) {
591 $result->{count} = $list->{count};
593 my $records = $cstore->request(
594 'open-ils.cstore.direct.biblio.record_entry.search.atomic',
595 { id => [ map { ( $_->[0] ) } @{$list->{ids}} ] }
598 for my $rec ( @$records ) {
600 my $u = OpenILS::Utils::ModsParser->new();
601 $u->start_mods_batch( $rec->marc );
602 my $mods = $u->finish_mods_batch();
604 push @{ $result->{records} }, { mvr => $mods, marcxml => $rec->marc, bibid => $rec->id };
610 $cstore->disconnect();
614 # ----------------------------------------------------------------------------
615 # These are the main OPAC search methods
616 # ----------------------------------------------------------------------------
618 __PACKAGE__->register_method(
619 method => 'the_quest_for_knowledge',
620 api_name => 'open-ils.search.biblio.multiclass',
622 Performs a multi class bilbli or metabib search
623 @param searchhash A search object layed out like so:
624 searches : { "$class" : "$value", ...}
625 org_unit : The org id to focus the search at
626 depth : The org depth
627 limit : The search limit
628 offset : The search offset
629 format : The MARC format
630 sort : What field to sort the results on [ author | title | pubdate ]
631 sort_dir : What direction do we sort? [ asc | desc ]
632 @return An object of the form
633 { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }
637 __PACKAGE__->register_method(
638 method => 'the_quest_for_knowledge',
639 api_name => 'open-ils.search.biblio.multiclass.staff',
640 signature => q/@see open-ils.search.biblio.multiclass/);
641 __PACKAGE__->register_method(
642 method => 'the_quest_for_knowledge',
643 api_name => 'open-ils.search.metabib.multiclass',
644 signature => q/@see open-ils.search.biblio.multiclass/);
645 __PACKAGE__->register_method(
646 method => 'the_quest_for_knowledge',
647 api_name => 'open-ils.search.metabib.multiclass.staff',
648 signature => q/@see open-ils.search.biblio.multiclass/);
650 sub the_quest_for_knowledge {
651 my( $self, $conn, $searchhash, $docache ) = @_;
653 return { count => 0 } unless $searchhash and
654 ref $searchhash->{searches} eq 'HASH';
656 my $method = 'open-ils.storage.biblio.multiclass.search_fts';
660 if($self->api_name =~ /metabib/) {
662 $method =~ s/biblio/metabib/o;
666 my $offset = $searchhash->{offset} || 0;
667 my $limit = $searchhash->{limit} || 10;
668 my $end = $offset + $limit - 1;
670 # do some simple sanity checking
671 if(!$searchhash->{searches} or
672 ( !grep { /^(?:title|author|subject|series|keyword)/ } keys %{$searchhash->{searches}} ) ) {
673 return { count => 0 };
678 $searchhash->{offset} = 0;
679 $searchhash->{limit} = $maxlimit;
681 return { count => 0 } if $offset > $maxlimit;
684 push( @search, ($_ => $$searchhash{$_})) for (sort keys %$searchhash);
685 my $s = OpenSRF::Utils::JSON->perl2JSON(\@search);
686 my $ckey = $pfx . md5_hex($method . $s);
688 $logger->info("bib search for: $s");
690 $searchhash->{limit} -= $offset;
694 my $result = ($docache) ? search_cache($ckey, $offset, $limit) : undef;
698 $method .= ".staff" if($self->api_name =~ /staff/);
699 $method .= ".atomic";
701 for (keys %$searchhash) {
702 delete $$searchhash{$_}
703 unless defined $$searchhash{$_};
706 $result = $U->storagereq( $method, %$searchhash );
713 return {count => 0} unless ($result && $$result[0]);
717 my $count = ($ismeta) ? $result->[0]->[3] : $result->[0]->[2];
720 # If we didn't get this data from the cache, put it into the cache
721 # then return the correct offset of records
722 $logger->debug("putting search cache $ckey\n");
723 put_cache($ckey, $count, \@recs);
727 # if we have the full set of data, trim out
728 # the requested chunk based on limit and offset
730 for ($offset..$end) {
731 last unless $recs[$_];
737 return { ids => \@recs, count => $count };
741 __PACKAGE__->register_method(
742 method => 'staged_search',
743 api_name => 'open-ils.search.biblio.multiclass.staged');
744 __PACKAGE__->register_method(
745 method => 'staged_search',
746 api_name => 'open-ils.search.biblio.multiclass.staged.staff',
747 signature => q/@see open-ils.search.biblio.multiclass.staged/);
748 __PACKAGE__->register_method(
749 method => 'staged_search',
750 api_name => 'open-ils.search.metabib.multiclass.staged',
751 signature => q/@see open-ils.search.biblio.multiclass.staged/);
752 __PACKAGE__->register_method(
753 method => 'staged_search',
754 api_name => 'open-ils.search.metabib.multiclass.staged.staff',
755 signature => q/@see open-ils.search.biblio.multiclass.staged/);
758 my($self, $conn, $search_hash, $docache) = @_;
760 my $method = ($self->api_name =~ /metabib/) ?
761 'open-ils.storage.metabib.multiclass.staged.search_fts':
762 'open-ils.storage.biblio.multiclass.staged.search_fts';
764 $method .= '.staff' if $self->api_name =~ /staff$/;
765 $method .= '.atomic';
768 my $user_offset = $search_hash->{offset} || 0; # user-specified offset
769 my $user_limit = $search_hash->{limit} || 10;
770 $user_offset = ($user_offset >= 0) ? $user_offset : 0;
771 $user_limit = ($user_limit >= 0) ? $user_limit : 10;
774 # we're grabbing results on a per-superpage basis, which means the
775 # limit and offset should coincide with superpage boundaries
776 $search_hash->{offset} = 0;
777 $search_hash->{limit} = $superpage_size;
779 # force a well-known check_limit
780 $search_hash->{check_limit} = $superpage_size;
781 # restrict total tested to superpage size * number of superpages
782 $search_hash->{core_limit} = $superpage_size * $max_superpages;
784 # Set the configured estimation strategy, defaults to 'inclusion'.
785 my $estimation_strategy = OpenSRF::Utils::SettingsClient
788 apps => 'open-ils.search', app_settings => 'estimation_strategy'
790 $search_hash->{estimation_strategy} = $estimation_strategy;
792 # pull any existing results from the cache
793 my $key = search_cache_key($method, $search_hash);
794 my $cache_data = $cache->get_cache($key) || {};
796 # keep retrieving results until we find enough to
797 # fulfill the user-specified limit and offset
798 my $all_results = [];
799 my $page; # current superpage
800 my $est_hit_count = 0;
801 my $current_page_summary = {};
802 my $global_summary = {checked => 0, visible => 0, excluded => 0, deleted => 0, total => 0};
804 for($page = 0; $page < $max_superpages; $page++) {
806 my $data = $cache_data->{$page};
810 $logger->debug("staged search: analyzing superpage $page");
813 # this window of results is already cached
814 $logger->debug("staged search: found cached results");
815 $summary = $data->{summary};
816 $results = $data->{results};
819 # retrieve the window of results from the database
820 $logger->debug("staged search: fetching results from the database");
821 $search_hash->{skip_check} = $page * $superpage_size;
823 $results = $U->storagereq($method, %$search_hash);
824 $search_duration = time - $start;
825 $logger->info("staged search: DB call took $search_duration seconds");
826 $summary = shift(@$results);
829 $logger->info("search timed out: duration=$search_duration: params=".
830 OpenSRF::Utils::JSON->perl2JSON($search_hash));
834 my $hc = $summary->{estimated_hit_count} || $summary->{visible};
836 $logger->info("search returned 0 results: duration=$search_duration: params=".
837 OpenSRF::Utils::JSON->perl2JSON($search_hash));
840 # Create backwards-compatible result structures
841 if($self->api_name =~ /biblio/) {
842 $results = [map {[$_->{id}]} @$results];
844 $results = [map {[$_->{id}, $_->{rel}, $_->{record}]} @$results];
847 $results = [grep {defined $_->[0]} @$results];
848 cache_staged_search_page($key, $page, $summary, $results) if $docache;
851 $current_page_summary = $summary;
853 # add the new set of results to the set under construction
854 push(@$all_results, @$results);
856 my $current_count = scalar(@$all_results);
858 $est_hit_count = $summary->{estimated_hit_count} || $summary->{visible}
861 $logger->debug("staged search: located $current_count, with estimated hits=".
862 $summary->{estimated_hit_count}." : visible=".$summary->{visible}.", checked=".$summary->{checked});
864 if (defined($summary->{estimated_hit_count})) {
865 $global_summary->{checked} += $summary->{checked};
866 $global_summary->{visible} += $summary->{visible};
867 $global_summary->{excluded} += $summary->{excluded};
868 $global_summary->{deleted} += $summary->{deleted};
869 $global_summary->{total} = $summary->{total};
872 # we've found all the possible hits
873 last if $current_count == $summary->{visible}
874 and not defined $summary->{estimated_hit_count};
876 # we've found enough results to satisfy the requested limit/offset
877 last if $current_count >= ($user_limit + $user_offset);
879 # we've scanned all possible hits
880 last if $summary->{checked} < $superpage_size;
883 my @results = grep {defined $_} @$all_results[$user_offset..($user_offset + $user_limit - 1)];
885 # refine the estimate if we have more than one superpage
887 if ($global_summary->{checked} >= $global_summary->{total}) {
888 $est_hit_count = $global_summary->{visible};
890 my $updated_hit_count = $U->storagereq(
891 'open-ils.storage.fts_paging_estimate',
892 $global_summary->{checked},
893 $global_summary->{visible},
894 $global_summary->{excluded},
895 $global_summary->{deleted},
896 $global_summary->{total}
898 $est_hit_count = $updated_hit_count->{$estimation_strategy};
903 count => $est_hit_count,
904 core_limit => $search_hash->{core_limit},
905 superpage_size => $search_hash->{check_limit},
906 superpage_summary => $current_page_summary,
911 # creates a unique token to represent the query in the cache
912 sub search_cache_key {
914 my $search_hash = shift;
916 for my $key (sort keys %$search_hash) {
917 push(@sorted, ($key => $$search_hash{$key}))
918 unless $key eq 'limit' or
920 $key eq 'skip_check';
922 my $s = OpenSRF::Utils::JSON->perl2JSON(\@sorted);
923 return $pfx . md5_hex($method . $s);
926 sub cache_staged_search_page {
927 # puts this set of results into the cache
928 my($key, $page, $summary, $results) = @_;
929 my $data = $cache->get_cache($key);
936 $logger->info("staged search: cached with key=$key, superpage=$page, estimated=".
937 $summary->{estimated_hit_count}.", visible=".$summary->{visible});
939 $cache->put_cache($key, $data, $cache_timeout);
948 my $end = $offset + $limit - 1;
950 $logger->debug("searching cache for $key : $start..$end\n");
952 return undef unless $cache;
953 my $data = $cache->get_cache($key);
955 return undef unless $data;
957 my $count = $data->[0];
960 return undef unless $offset < $count;
963 for( my $i = $offset; $i <= $end; $i++ ) {
964 last unless my $d = $$data[$i];
968 $logger->debug("search_cache found ".scalar(@result)." items for count=$count, start=$start, end=$end");
975 my( $key, $count, $data ) = @_;
976 return undef unless $cache;
977 $logger->debug("search_cache putting ".
978 scalar(@$data)." items at key $key with timeout $cache_timeout");
979 $cache->put_cache($key, [ $count, $data ], $cache_timeout);
987 __PACKAGE__->register_method(
988 method => "biblio_mrid_to_modsbatch_batch",
989 api_name => "open-ils.search.biblio.metarecord.mods_slim.batch.retrieve");
991 sub biblio_mrid_to_modsbatch_batch {
992 my( $self, $client, $mrids) = @_;
993 warn "Performing mrid_to_modsbatch_batch...";
995 my $method = $self->method_lookup("open-ils.search.biblio.metarecord.mods_slim.retrieve");
996 for my $id (@$mrids) {
997 next unless defined $id;
998 my ($m) = $method->run($id);
1005 __PACKAGE__->register_method(
1006 method => "biblio_mrid_to_modsbatch",
1007 api_name => "open-ils.search.biblio.metarecord.mods_slim.retrieve",
1008 notes => <<" NOTES");
1009 Returns the mvr associated with a given metarecod. If none exists,
1013 __PACKAGE__->register_method(
1014 method => "biblio_mrid_to_modsbatch",
1015 api_name => "open-ils.search.biblio.metarecord.mods_slim.retrieve.staff",
1016 notes => <<" NOTES");
1017 Returns the mvr associated with a given metarecod. If none exists,
1021 sub biblio_mrid_to_modsbatch {
1022 my( $self, $client, $mrid, $args) = @_;
1024 warn "Grabbing mvr for $mrid\n";
1026 my ($mr, $evt) = _grab_metarecord($mrid);
1027 return $evt unless $mr;
1029 my $mvr = biblio_mrid_check_mvr($self, $client, $mr);
1030 $mvr = biblio_mrid_make_modsbatch( $self, $client, $mr ) unless $mvr;
1032 return $mvr unless ref($args);
1034 # Here we find the lead record appropriate for the given filters
1035 # and use that for the title and author of the metarecord
1036 my $format = $$args{format};
1037 my $org = $$args{org};
1038 my $depth = $$args{depth};
1040 return $mvr unless $format or $org or $depth;
1042 my $method = "open-ils.storage.ordered.metabib.metarecord.records";
1043 $method = "$method.staff" if $self->api_name =~ /staff/o;
1045 my $rec = $U->storagereq($method, $format, $org, $depth, 1);
1047 if( my $mods = $U->record_to_mvr($rec) ) {
1049 $mvr->title($mods->title);
1050 $mvr->title($mods->author);
1051 $logger->debug("mods_slim updating title and ".
1052 "author in mvr with ".$mods->title." : ".$mods->author);
1058 # converts a metarecord to an mvr
1061 my $perl = OpenSRF::Utils::JSON->JSON2perl($mr->mods());
1062 return Fieldmapper::metabib::virtual_record->new($perl);
1065 # checks to see if a metarecord has mods, if so returns true;
1067 __PACKAGE__->register_method(
1068 method => "biblio_mrid_check_mvr",
1069 api_name => "open-ils.search.biblio.metarecord.mods_slim.check",
1070 notes => <<" NOTES");
1071 Takes a metarecord ID or a metarecord object and returns true
1072 if the metarecord already has an mvr associated with it.
1075 sub biblio_mrid_check_mvr {
1076 my( $self, $client, $mrid ) = @_;
1080 if(ref($mrid)) { $mr = $mrid; }
1081 else { ($mr, $evt) = _grab_metarecord($mrid); }
1082 return $evt if $evt;
1084 warn "Checking mvr for mr " . $mr->id . "\n";
1086 return _mr_to_mvr($mr) if $mr->mods();
1090 sub _grab_metarecord {
1092 #my $e = OpenILS::Utils::Editor->new;
1093 my $e = new_editor();
1094 my $mr = $e->retrieve_metabib_metarecord($mrid) or return ( undef, $e->event );
1099 __PACKAGE__->register_method(
1100 method => "biblio_mrid_make_modsbatch",
1101 api_name => "open-ils.search.biblio.metarecord.mods_slim.create",
1102 notes => <<" NOTES");
1103 Takes either a metarecord ID or a metarecord object.
1104 Forces the creations of an mvr for the given metarecord.
1105 The created mvr is returned.
1108 sub biblio_mrid_make_modsbatch {
1109 my( $self, $client, $mrid ) = @_;
1111 #my $e = OpenILS::Utils::Editor->new;
1112 my $e = new_editor();
1119 $mr = $e->retrieve_metabib_metarecord($mrid)
1120 or return $e->event;
1123 my $masterid = $mr->master_record;
1124 $logger->info("creating new mods batch for metarecord=$mrid, master record=$masterid");
1126 my $ids = $U->storagereq(
1127 'open-ils.storage.ordered.metabib.metarecord.records.staff.atomic', $mrid);
1128 return undef unless @$ids;
1130 my $master = $e->retrieve_biblio_record_entry($masterid)
1131 or return $e->event;
1133 # start the mods batch
1134 my $u = OpenILS::Utils::ModsParser->new();
1135 $u->start_mods_batch( $master->marc );
1137 # grab all of the sub-records and shove them into the batch
1138 my @ids = grep { $_ ne $masterid } @$ids;
1139 #my $subrecs = (@ids) ? $e->batch_retrieve_biblio_record_entry(\@ids) : [];
1144 my $r = $e->retrieve_biblio_record_entry($i);
1145 push( @$subrecs, $r ) if $r;
1150 $logger->debug("adding record ".$_->id." to mods batch for metarecord=$mrid");
1151 $u->push_mods_batch( $_->marc ) if $_->marc;
1155 # finish up and send to the client
1156 my $mods = $u->finish_mods_batch();
1157 $mods->doc_id($mrid);
1158 $client->respond_complete($mods);
1161 # now update the mods string in the db
1162 my $string = OpenSRF::Utils::JSON->perl2JSON($mods->decast);
1165 #$e = OpenILS::Utils::Editor->new(xact => 1);
1166 $e = new_editor(xact => 1);
1167 $e->update_metabib_metarecord($mr)
1168 or $logger->error("Error setting mods text on metarecord $mrid : " . Dumper($e->event));
1177 # converts a mr id into a list of record ids
1179 __PACKAGE__->register_method(
1180 method => "biblio_mrid_to_record_ids",
1181 api_name => "open-ils.search.biblio.metarecord_to_records",
1184 __PACKAGE__->register_method(
1185 method => "biblio_mrid_to_record_ids",
1186 api_name => "open-ils.search.biblio.metarecord_to_records.staff",
1189 sub biblio_mrid_to_record_ids {
1190 my( $self, $client, $mrid, $args ) = @_;
1192 my $format = $$args{format};
1193 my $org = $$args{org};
1194 my $depth = $$args{depth};
1196 my $method = "open-ils.storage.ordered.metabib.metarecord.records.atomic";
1197 $method =~ s/atomic/staff\.atomic/o if $self->api_name =~ /staff/o;
1198 my $recs = $U->storagereq($method, $mrid, $format, $org, $depth);
1200 return { count => scalar(@$recs), ids => $recs };
1204 __PACKAGE__->register_method(
1205 method => "biblio_record_to_marc_html",
1206 api_name => "open-ils.search.biblio.record.html" );
1208 my $parser = XML::LibXML->new();
1209 my $xslt = XML::LibXSLT->new();
1212 my $settings_client = OpenSRF::Utils::SettingsClient->new();
1213 sub biblio_record_to_marc_html {
1214 my( $self, $client, $recordid ) = @_;
1216 if( !$marc_sheet ) {
1217 my $dir = $settings_client->config_value( "dirs", "xsl" );
1218 my $xsl = $settings_client->config_value(
1219 "apps", "open-ils.search", "app_settings", "marc_html_xsl" );
1221 $xsl = $parser->parse_file("$dir/$xsl");
1222 $marc_sheet = $xslt->parse_stylesheet( $xsl );
1226 my $record = $apputils->simple_scalar_request(
1228 "open-ils.cstore.direct.biblio.record_entry.retrieve",
1231 my $xmldoc = $parser->parse_string($record->marc);
1232 my $html = $marc_sheet->transform($xmldoc);
1233 $html = $html->toString();
1240 __PACKAGE__->register_method(
1241 method => "retrieve_all_copy_locations",
1242 api_name => "open-ils.search.config.copy_location.retrieve.all" );
1244 my $shelving_locations;
1245 sub retrieve_all_copy_locations {
1246 my( $self, $client ) = @_;
1247 if(!$shelving_locations) {
1248 $shelving_locations = $apputils->simple_scalar_request(
1250 "open-ils.cstore.direct.asset.copy_location.search.atomic",
1251 { id => { "!=" => undef } }
1254 return $shelving_locations;
1260 __PACKAGE__->register_method(
1261 method => "retrieve_all_copy_statuses",
1262 api_name => "open-ils.search.config.copy_status.retrieve.all" );
1265 sub retrieve_all_copy_statuses {
1266 my( $self, $client ) = @_;
1267 return $copy_statuses if $copy_statuses;
1268 return $copy_statuses =
1269 new_editor()->retrieve_all_config_copy_status();
1273 __PACKAGE__->register_method(
1274 method => "copy_counts_per_org",
1275 api_name => "open-ils.search.biblio.copy_counts.retrieve");
1277 __PACKAGE__->register_method(
1278 method => "copy_counts_per_org",
1279 api_name => "open-ils.search.biblio.copy_counts.retrieve.staff");
1281 sub copy_counts_per_org {
1282 my( $self, $client, $record_id ) = @_;
1284 warn "Retreiveing copy copy counts for record $record_id and method " . $self->api_name . "\n";
1286 my $method = "open-ils.storage.biblio.record_entry.global_copy_count.atomic";
1287 if($self->api_name =~ /staff/) { $method =~ s/atomic/staff\.atomic/; }
1289 my $counts = $apputils->simple_scalar_request(
1290 "open-ils.storage", $method, $record_id );
1292 $counts = [ sort {$a->[0] <=> $b->[0]} @$counts ];
1297 __PACKAGE__->register_method(
1298 method => "copy_count_summary",
1299 api_name => "open-ils.search.biblio.copy_counts.summary.retrieve",
1300 notes => <<" NOTES");
1301 returns an array of these:
1302 [ org_id, callnumber_label, <status1_count>, <status2_cout>,...]
1303 where statusx is a copy status name. the statuses are sorted
1307 sub copy_count_summary {
1308 my( $self, $client, $rid, $org, $depth ) = @_;
1311 my $data = $U->storagereq(
1312 'open-ils.storage.biblio.record_entry.status_copy_count.atomic', $rid, $org, $depth );
1314 return [ sort { $a->[1] cmp $b->[1] } @$data ];
1320 __PACKAGE__->register_method(
1321 method => "multiclass_search",
1322 api_name => "open-ils.search.biblio.multiclass",
1323 notes => <<" NOTES");
1324 Performs a multiclass search
1325 PARAMS( searchBlob, org_unit, format, limit )
1326 where searchBlob is defined like this:
1328 "title" : { "term" : "water" },
1329 "author" : { "term" : "smith" },
1334 __PACKAGE__->register_method(
1335 method => "multiclass_search",
1336 api_name => "open-ils.search.biblio.multiclass.staff",
1337 notes => "see open-ils.search.biblio.multiclass" );
1339 sub multiclass_search {
1340 my( $self, $client, $searchBlob, $orgid, $format, $limit ) = @_;
1342 $logger->debug("Performing multiclass search with org => $orgid, " .
1343 "format => $format, limit => $limit, and search blob " . Dumper($searchBlob));
1345 my $meth = 'open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.atomic';
1346 if($self->api_name =~ /staff/) { $meth =~ s/metarecord\.atomic/metarecord.staff.atomic/; }
1349 my $records = $apputils->simplereq(
1350 'open-ils.storage', $meth,
1351 org_unit => $orgid, searches => $searchBlob, format => $format, limit => $limit );
1356 if( ref($records) and $records->[0] and
1357 defined($records->[0]->[3])) { $count = $records->[0]->[3];}
1359 for my $r (@$records) { push( @$recs, $r ) if ($r and $r->[0]); }
1361 # records has the form: [ mrid, rank, singleRecord / 0, hitCount ];
1362 return { ids => $recs, count => $count };
1368 __PACKAGE__->register_method(
1369 method => "multiclass_search",
1370 api_name => "open-ils.search.biblio.multiclass",
1372 Performs a multiclass search
1373 @param args A names hash of arguments:
1374 org_unit : The org to focus the search on
1375 depth : The search depth
1376 format : Item format
1377 limit : Return limit
1378 offset : Search offset
1379 searches : A named hash of searches which has the following format:
1381 "title" : { "term" : "water" },
1382 "author" : { "term" : "smith" },
1385 @return { ids : <array of ids>, count : hitcount }
1389 __PACKAGE__->register_method(
1390 method => "multiclass_search",
1391 api_name => "open-ils.search.biblio.multiclass.staff",
1392 notes => q/@see open-ils.search.biblio.multiclass/ );
1394 sub multiclass_search {
1395 my( $self, $client, $args ) = @_;
1397 $logger->debug("Performing multiclass search with args:\n" . Dumper($args));
1398 my $meth = 'open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.atomic';
1399 if($self->api_name =~ /staff/) { $meth =~ s/metarecord\.atomic/metarecord.staff.atomic/; }
1401 my $records = $apputils->simplereq( 'open-ils.storage', $meth, %$args );
1406 if( ref($records) and $records->[0] and
1407 defined($records->[0]->[3])) { $count = $records->[0]->[3];}
1409 for my $r (@$records) { push( @$recs, $r ) if ($r and $r->[0]); }
1411 return { ids => $recs, count => $count };
1418 __PACKAGE__->register_method(
1419 method => "marc_search",
1420 api_name => "open-ils.search.biblio.marc.staff");
1422 __PACKAGE__->register_method(
1423 method => "marc_search",
1424 api_name => "open-ils.search.biblio.marc",
1425 notes => <<" NOTES");
1427 open-ils.storage.biblio.full_rec.multi_search.atomic
1428 { "searches": [{"term":"harry","restrict": [{"tag":245,"subfield":"a"}]}], "org_unit": 1,
1429 "limit":5,"sort":"author","item_type":"g"}
1433 my( $self, $conn, $args, $limit, $offset ) = @_;
1435 my $method = 'open-ils.storage.biblio.full_rec.multi_search';
1436 $method .= ".staff" if $self->api_name =~ /staff/;
1437 $method .= ".atomic";
1443 push( @search, ($_ => $$args{$_}) ) for (sort keys %$args);
1444 my $ckey = $pfx . md5_hex($method . OpenSRF::Utils::JSON->perl2JSON(\@search));
1446 my $recs = search_cache($ckey, $offset, $limit);
1449 $recs = $U->storagereq($method, %$args) || [];
1451 put_cache($ckey, scalar(@$recs), $recs);
1452 $recs = [ @$recs[$offset..($offset + ($limit - 1))] ];
1459 $count = $recs->[0]->[2] if $recs->[0] and $recs->[0]->[2];
1460 my @recs = map { $_->[0] } @$recs;
1462 return { ids => \@recs, count => $count };
1466 __PACKAGE__->register_method(
1467 method => "biblio_search_isbn",
1468 api_name => "open-ils.search.biblio.isbn",
1471 sub biblio_search_isbn {
1472 my( $self, $client, $isbn ) = @_;
1473 $logger->debug("Searching ISBN $isbn");
1474 my $e = new_editor();
1475 my $recs = $U->storagereq(
1476 'open-ils.storage.id_list.biblio.record_entry.search.isbn.atomic', $isbn );
1477 return { ids => $recs, count => scalar(@$recs) };
1481 __PACKAGE__->register_method(
1482 method => "biblio_search_issn",
1483 api_name => "open-ils.search.biblio.issn",
1486 sub biblio_search_issn {
1487 my( $self, $client, $issn ) = @_;
1488 $logger->debug("Searching ISSN $issn");
1489 my $e = new_editor();
1490 my $recs = $U->storagereq(
1491 'open-ils.storage.id_list.biblio.record_entry.search.issn.atomic', $issn );
1492 return { ids => $recs, count => scalar(@$recs) };
1498 __PACKAGE__->register_method(
1499 method => "fetch_mods_by_copy",
1500 api_name => "open-ils.search.biblio.mods_from_copy",
1503 sub fetch_mods_by_copy {
1504 my( $self, $client, $copyid ) = @_;
1505 my ($record, $evt) = $apputils->fetch_record_by_copy( $copyid );
1506 return $evt if $evt;
1507 return OpenILS::Event->new('ITEM_NOT_CATALOGED') unless $record->marc;
1508 return $apputils->record_to_mvr($record);
1513 # -------------------------------------------------------------------------------------
1515 __PACKAGE__->register_method(
1516 method => "cn_browse",
1517 api_name => "open-ils.search.callnumber.browse.target",
1518 notes => "Starts a callnumber browse"
1521 __PACKAGE__->register_method(
1522 method => "cn_browse",
1523 api_name => "open-ils.search.callnumber.browse.page_up",
1524 notes => "Returns the previous page of callnumbers",
1527 __PACKAGE__->register_method(
1528 method => "cn_browse",
1529 api_name => "open-ils.search.callnumber.browse.page_down",
1530 notes => "Returns the next page of callnumbers",
1534 # RETURNS array of arrays like so: label, owning_lib, record, id
1536 my( $self, $client, @params ) = @_;
1539 $method = 'open-ils.storage.asset.call_number.browse.target.atomic'
1540 if( $self->api_name =~ /target/ );
1541 $method = 'open-ils.storage.asset.call_number.browse.page_up.atomic'
1542 if( $self->api_name =~ /page_up/ );
1543 $method = 'open-ils.storage.asset.call_number.browse.page_down.atomic'
1544 if( $self->api_name =~ /page_down/ );
1546 return $apputils->simplereq( 'open-ils.storage', $method, @params );
1548 # -------------------------------------------------------------------------------------
1550 __PACKAGE__->register_method(
1551 method => "fetch_cn",
1553 api_name => "open-ils.search.callnumber.retrieve",
1554 notes => "retrieves a callnumber based on ID",
1558 my( $self, $client, $id ) = @_;
1559 my( $cn, $evt ) = $apputils->fetch_callnumber( $id );
1560 return $evt if $evt;
1564 __PACKAGE__->register_method (
1565 method => "fetch_copy_by_cn",
1566 api_name => 'open-ils.search.copies_by_call_number.retrieve',
1568 Returns an array of copy id's by callnumber id
1569 @param cnid The callnumber id
1570 @return An array of copy ids
1574 sub fetch_copy_by_cn {
1575 my( $self, $conn, $cnid ) = @_;
1576 return $U->cstorereq(
1577 'open-ils.cstore.direct.asset.copy.id_list.atomic',
1578 { call_number => $cnid, deleted => 'f' } );
1581 __PACKAGE__->register_method (
1582 method => 'fetch_cn_by_info',
1583 api_name => 'open-ils.search.call_number.retrieve_by_info',
1585 @param label The callnumber label
1586 @param record The record the cn is attached to
1587 @param org The owning library of the cn
1588 @return The callnumber object
1593 sub fetch_cn_by_info {
1594 my( $self, $conn, $label, $record, $org ) = @_;
1595 return $U->cstorereq(
1596 'open-ils.cstore.direct.asset.call_number.search',
1597 { label => $label, record => $record, owning_lib => $org, deleted => 'f' });
1604 __PACKAGE__->register_method (
1605 method => 'bib_extras',
1606 api_name => 'open-ils.search.biblio.lit_form_map.retrieve.all');
1607 __PACKAGE__->register_method (
1608 method => 'bib_extras',
1609 api_name => 'open-ils.search.biblio.item_form_map.retrieve.all');
1610 __PACKAGE__->register_method (
1611 method => 'bib_extras',
1612 api_name => 'open-ils.search.biblio.item_type_map.retrieve.all');
1613 __PACKAGE__->register_method (
1614 method => 'bib_extras',
1615 api_name => 'open-ils.search.biblio.bib_level_map.retrieve.all');
1616 __PACKAGE__->register_method (
1617 method => 'bib_extras',
1618 api_name => 'open-ils.search.biblio.audience_map.retrieve.all');
1623 my $e = new_editor();
1625 return $e->retrieve_all_config_lit_form_map()
1626 if( $self->api_name =~ /lit_form/ );
1628 return $e->retrieve_all_config_item_form_map()
1629 if( $self->api_name =~ /item_form_map/ );
1631 return $e->retrieve_all_config_item_type_map()
1632 if( $self->api_name =~ /item_type_map/ );
1634 return $e->retrieve_all_config_bib_level_map()
1635 if( $self->api_name =~ /bib_level_map/ );
1637 return $e->retrieve_all_config_audience_map()
1638 if( $self->api_name =~ /audience_map/ );
1645 __PACKAGE__->register_method(
1646 method => 'fetch_slim_record',
1647 api_name => 'open-ils.search.biblio.record_entry.slim.retrieve',
1649 Returns a biblio.record_entry without the attached marcxml
1653 sub fetch_slim_record {
1654 my( $self, $conn, $ids ) = @_;
1656 #my $editor = OpenILS::Utils::Editor->new;
1657 my $editor = new_editor();
1660 return $editor->event unless
1661 my $r = $editor->retrieve_biblio_record_entry($_);
1670 __PACKAGE__->register_method(
1671 method => 'rec_to_mr_rec_descriptors',
1672 api_name => 'open-ils.search.metabib.record_to_descriptors',
1674 specialized method...
1675 Given a biblio record id or a metarecord id,
1676 this returns a list of metabib.record_descriptor
1677 objects that live within the same metarecord
1678 @param args Object of args including:
1682 sub rec_to_mr_rec_descriptors {
1683 my( $self, $conn, $args ) = @_;
1685 my $rec = $$args{record};
1686 my $mrec = $$args{metarecord};
1687 my $item_forms = $$args{item_forms};
1688 my $item_types = $$args{item_types};
1689 my $item_lang = $$args{item_lang};
1691 my $e = new_editor();
1695 my $map = $e->search_metabib_metarecord_source_map({source => $rec});
1696 return $e->event unless @$map;
1697 $mrec = $$map[0]->metarecord;
1700 $recs = $e->search_metabib_metarecord_source_map({metarecord => $mrec});
1701 return $e->event unless @$recs;
1703 my @recs = map { $_->source } @$recs;
1704 my $search = { record => \@recs };
1705 $search->{item_form} = $item_forms if $item_forms and @$item_forms;
1706 $search->{item_type} = $item_types if $item_types and @$item_types;
1707 $search->{item_lang} = $item_lang if $item_lang;
1709 my $desc = $e->search_metabib_record_descriptor($search);
1711 return { metarecord => $mrec, descriptors => $desc };
1717 __PACKAGE__->register_method(
1718 method => 'copies_created_on',
1722 sub copies_created_on {
1723 my( $self, $conn, $auth, $org, $date ) = @_;
1724 my $e = new_editor(authtoken=>$auth);
1725 return $e->event unless $e->checkauth;
1729 __PACKAGE__->register_method(
1730 method => 'fetch_age_protect',
1731 api_name => 'open-ils.search.copy.age_protect.retrieve.all',
1734 sub fetch_age_protect {
1735 return new_editor()->retrieve_all_config_rule_age_hold_protect();
1739 __PACKAGE__->register_method(
1740 method => 'copies_by_cn_label',
1741 api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label',
1744 __PACKAGE__->register_method(
1745 method => 'copies_by_cn_label',
1746 api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label.staff',
1749 sub copies_by_cn_label {
1750 my( $self, $conn, $record, $label, $circ_lib ) = @_;
1751 my $e = new_editor();
1752 my $cns = $e->search_asset_call_number({record => $record, label => $label, deleted => 'f'}, {idlist=>1});
1753 return [] unless @$cns;
1755 # show all non-deleted copies in the staff client ...
1756 if ($self->api_name =~ /staff$/o) {
1757 return $e->search_asset_copy({call_number => $cns, circ_lib => $circ_lib, deleted => 'f'}, {idlist=>1});
1760 # ... otherwise, grab the copies ...
1761 my $copies = $e->search_asset_copy(
1762 [ {call_number => $cns, circ_lib => $circ_lib, deleted => 'f', opac_visible => 't'},
1763 {flesh => 1, flesh_fields => { acp => [ qw/location status/] } }
1767 # ... and test for location and status visibility
1768 return [ map { ($U->is_true($_->location->opac_visible) && $U->is_true($_->status->opac_visible)) ? ($_->id) : () } @$copies ];