1 package OpenILS::Application::Search::Biblio;
2 use base qw/OpenSRF::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_";
41 $cache = OpenSRF::Utils::Cache->new('global');
42 my $sclient = OpenSRF::Utils::SettingsClient->new();
43 $cache_timeout = $sclient->config_value(
44 "apps", "open-ils.search", "app_settings", "cache_timeout" ) || 300;
45 $logger->info("Search cache timeout is $cache_timeout");
50 # ---------------------------------------------------------------------------
51 # takes a list of record id's and turns the docs into friendly
52 # mods structures. Creates one MODS structure for each doc id.
53 # ---------------------------------------------------------------------------
54 sub _records_to_mods {
60 my $session = OpenSRF::AppSession->create("open-ils.cstore");
61 my $request = $session->request(
62 "open-ils.cstore.direct.biblio.record_entry.search", { id => \@ids } );
64 while( my $resp = $request->recv ) {
65 my $content = $resp->content;
66 next if $content->id == OILS_PRECAT_RECORD;
67 my $u = OpenILS::Utils::ModsParser->new();
68 $u->start_mods_batch( $content->marc );
69 my $mods = $u->finish_mods_batch();
70 $mods->doc_id($content->id());
71 $mods->tcn($content->tcn_value);
75 $session->disconnect();
79 __PACKAGE__->register_method(
80 method => "record_id_to_mods",
81 api_name => "open-ils.search.biblio.record.mods.retrieve",
83 note => "Provide ID, we provide the mods"
86 # converts a record into a mods object with copy counts attached
87 sub record_id_to_mods {
89 my( $self, $client, $org_id, $id ) = @_;
91 my $mods_list = _records_to_mods( $id );
92 my $mods_obj = $mods_list->[0];
93 my $cmethod = $self->method_lookup(
94 "open-ils.search.biblio.record.copy_count");
95 my ($count) = $cmethod->run($org_id, $id);
96 $mods_obj->copy_count($count);
103 __PACKAGE__->register_method(
104 method => "record_id_to_mods_slim",
105 api_name => "open-ils.search.biblio.record.mods_slim.retrieve",
107 note => "Provide ID, we provide the mods"
110 # converts a record into a mods object with NO copy counts attached
111 sub record_id_to_mods_slim {
112 my( $self, $client, $id ) = @_;
113 return undef unless defined $id;
115 if(ref($id) and ref($id) == 'ARRAY') {
116 return _records_to_mods( @$id );
118 my $mods_list = _records_to_mods( $id );
119 my $mods_obj = $mods_list->[0];
120 return OpenILS::Event->new('BIBLIO_RECORD_ENTRY_NOT_FOUND') unless $mods_obj;
125 # Returns the number of copies attached to a record based on org location
126 __PACKAGE__->register_method(
127 method => "record_id_to_copy_count",
128 api_name => "open-ils.search.biblio.record.copy_count",
131 __PACKAGE__->register_method(
132 method => "record_id_to_copy_count",
133 api_name => "open-ils.search.biblio.record.copy_count.staff",
136 __PACKAGE__->register_method(
137 method => "record_id_to_copy_count",
138 api_name => "open-ils.search.biblio.metarecord.copy_count",
141 __PACKAGE__->register_method(
142 method => "record_id_to_copy_count",
143 api_name => "open-ils.search.biblio.metarecord.copy_count.staff",
145 sub record_id_to_copy_count {
146 my( $self, $client, $org_id, $record_id, $format ) = @_;
148 return [] unless $record_id;
149 $format = undef if (!$format or $format eq 'all');
151 my $method = "open-ils.storage.biblio.record_entry.copy_count.atomic";
154 if($self->api_name =~ /metarecord/) {
155 $method = "open-ils.storage.metabib.metarecord.copy_count.atomic";
159 $method =~ s/atomic/staff\.atomic/og if($self->api_name =~ /staff/ );
161 my $count = $U->storagereq( $method,
162 org_unit => $org_id, $key => $record_id, format => $format );
164 return [ sort { $a->{depth} <=> $b->{depth} } @$count ];
170 __PACKAGE__->register_method(
171 method => "biblio_search_tcn",
172 api_name => "open-ils.search.biblio.tcn",
174 note => "Retrieve a record by TCN",
177 sub biblio_search_tcn {
179 my( $self, $client, $tcn, $include_deleted ) = @_;
181 $tcn =~ s/.*?(\w+)\s*$/$1/o;
183 my $e = new_editor();
184 my $search = {tcn_value => $tcn};
185 $search->{deleted} = 'f' unless $include_deleted;
186 my $recs = $e->search_biblio_record_entry( $search, {idlist =>1} );
188 return { count => scalar(@$recs), ids => $recs };
192 # --------------------------------------------------------------------------------
194 __PACKAGE__->register_method(
195 method => "biblio_barcode_to_copy",
196 api_name => "open-ils.search.asset.copy.find_by_barcode",);
197 sub biblio_barcode_to_copy {
198 my( $self, $client, $barcode ) = @_;
199 my( $copy, $evt ) = $U->fetch_copy_by_barcode($barcode);
204 __PACKAGE__->register_method(
205 method => "biblio_id_to_copy",
206 api_name => "open-ils.search.asset.copy.batch.retrieve",);
207 sub biblio_id_to_copy {
208 my( $self, $client, $ids ) = @_;
209 $logger->info("Fetching copies @$ids");
210 return $U->cstorereq(
211 "open-ils.cstore.direct.asset.copy.search.atomic", { id => $ids } );
215 __PACKAGE__->register_method(
216 method => "copy_retrieve",
217 api_name => "open-ils.search.asset.copy.retrieve",);
219 my( $self, $client, $cid ) = @_;
220 my( $copy, $evt ) = $U->fetch_copy($cid);
225 __PACKAGE__->register_method(
226 method => "volume_retrieve",
227 api_name => "open-ils.search.asset.call_number.retrieve");
228 sub volume_retrieve {
229 my( $self, $client, $vid ) = @_;
230 my $e = new_editor();
231 my $vol = $e->retrieve_asset_call_number($vid) or return $e->event;
235 __PACKAGE__->register_method(
236 method => "fleshed_copy_retrieve_batch",
237 api_name => "open-ils.search.asset.copy.fleshed.batch.retrieve");
239 sub fleshed_copy_retrieve_batch {
240 my( $self, $client, $ids ) = @_;
241 $logger->info("Fetching fleshed copies @$ids");
242 return $U->cstorereq(
243 "open-ils.cstore.direct.asset.copy.search.atomic",
246 flesh_fields => { acp => [ qw/ circ_lib location status stat_cat_entries / ] }
251 __PACKAGE__->register_method(
252 method => "fleshed_copy_retrieve",
253 api_name => "open-ils.search.asset.copy.fleshed.retrieve",);
255 sub fleshed_copy_retrieve {
256 my( $self, $client, $id ) = @_;
257 my( $c, $e) = $U->fetch_fleshed_copy($id);
264 __PACKAGE__->register_method(
265 method => 'fleshed_by_barcode',
266 api_name => "open-ils.search.asset.copy.fleshed2.find_by_barcode",);
267 sub fleshed_by_barcode {
268 my( $self, $conn, $barcode ) = @_;
269 my $e = new_editor();
270 my $copyid = $e->search_asset_copy(
271 {barcode => $barcode, deleted => 'f'}, {idlist=>1})->[0]
273 return $self->fleshed_copy_retrieve2($conn, $copyid);
277 __PACKAGE__->register_method(
278 method => "fleshed_copy_retrieve2",
279 api_name => "open-ils.search.asset.copy.fleshed2.retrieve",);
281 sub fleshed_copy_retrieve2 {
282 my( $self, $client, $id ) = @_;
283 my $e = new_editor();
284 my $copy = $e->retrieve_asset_copy(
290 acp => [ qw/ location status stat_cat_entry_copy_maps notes age_protect / ],
291 ascecm => [ qw/ stat_cat stat_cat_entry / ],
295 ) or return $e->event;
297 # For backwards compatibility
298 #$copy->stat_cat_entries($copy->stat_cat_entry_copy_maps);
300 if( $copy->status->id == OILS_COPY_STATUS_CHECKED_OUT ) {
302 $e->search_action_circulation(
304 { target_copy => $copy->id },
306 order_by => { circ => 'xact_start desc' },
318 __PACKAGE__->register_method(
319 method => 'flesh_copy_custom',
320 api_name => 'open-ils.search.asset.copy.fleshed.custom'
323 sub flesh_copy_custom {
324 my( $self, $conn, $copyid, $fields ) = @_;
325 my $e = new_editor();
326 my $copy = $e->retrieve_asset_copy(
336 ) or return $e->event;
345 __PACKAGE__->register_method(
346 method => "biblio_barcode_to_title",
347 api_name => "open-ils.search.biblio.find_by_barcode",
350 sub biblio_barcode_to_title {
351 my( $self, $client, $barcode ) = @_;
353 my $title = $apputils->simple_scalar_request(
355 "open-ils.storage.biblio.record_entry.retrieve_by_barcode", $barcode );
357 return { ids => [ $title->id ], count => 1 } if $title;
358 return { count => 0 };
361 __PACKAGE__->register_method(
362 method => 'title_id_by_item_barcode',
363 api_name => 'open-ils.search.bib_id.by_barcode'
366 sub title_id_by_item_barcode {
367 my( $self, $conn, $barcode ) = @_;
368 my $e = new_editor();
369 my $copies = $e->search_asset_copy(
371 { deleted => 'f', barcode => $barcode },
375 acp => [ 'call_number' ],
382 return $e->event unless @$copies;
383 return $$copies[0]->call_number->record->id;
387 __PACKAGE__->register_method(
388 method => "biblio_copy_to_mods",
389 api_name => "open-ils.search.biblio.copy.mods.retrieve",
392 # takes a copy object and returns it fleshed mods object
393 sub biblio_copy_to_mods {
394 my( $self, $client, $copy ) = @_;
396 my $volume = $U->cstorereq(
397 "open-ils.cstore.direct.asset.call_number.retrieve",
398 $copy->call_number() );
400 my $mods = _records_to_mods($volume->record());
401 $mods = shift @$mods;
402 $volume->copies([$copy]);
403 push @{$mods->call_numbers()}, $volume;
409 __PACKAGE__->register_method(
410 api_name => 'open-ils.search.biblio.multiclass.query',
411 method => 'multiclass_query',
413 @param arghash @see open-ils.search.biblio.multiclass
414 @param query Raw human-readable query string.
415 Recognized search keys include:
416 keyword/kw - search keyword(s)
417 author/au/name - search author(s)
418 title/ti - search title
419 subject/su - search subject
420 series/se - search series
421 lang - limit by language (specifiy multiple langs with lang:l1 lang:l2 ...)
422 site - search at specified org unit, corresponds to actor.org_unit.shortname
423 sort - sort type (title, author, pubdate)
424 dir - sort direction (asc, desc)
425 available - if set to anything other than "false" or "0", limits to available items
427 keyword, title, author, subject, and series support additional search
428 subclasses, specified with a "|". For example, "title|proper:gone with the wind"
429 For more, see config.metabib_field
431 @param nocache @see open-ils.search.biblio.multiclass
434 __PACKAGE__->register_method(
435 api_name => 'open-ils.search.biblio.multiclass.query.staff',
436 method => 'multiclass_query',
437 signature => '@see open-ils.search.biblio.multiclass.query');
438 __PACKAGE__->register_method(
439 api_name => 'open-ils.search.metabib.multiclass.query',
440 method => 'multiclass_query',
441 signature => '@see open-ils.search.biblio.multiclass.query');
442 __PACKAGE__->register_method(
443 api_name => 'open-ils.search.metabib.multiclass.query.staff',
444 method => 'multiclass_query',
445 signature => '@see open-ils.search.biblio.multiclass.query');
447 sub multiclass_query {
448 my($self, $conn, $arghash, $query, $docache) = @_;
450 $logger->debug("initial search query => $query");
452 $query = decode_utf8($query);
455 $query =~ s/^\s+//go;
457 # convert convenience classes (e.g. kw for keyword) to the full class name
458 $query =~ s/kw(:|\|)/keyword$1/go;
459 $query =~ s/ti(:|\|)/title$1/go;
460 $query =~ s/au(:|\|)/author$1/go;
461 $query =~ s/su(:|\|)/subject$1/go;
462 $query =~ s/se(:|\|)/series$1/go;
463 $query =~ s/name(:|\|)/author$1/og;
465 $logger->debug("cleansed query string => $query");
466 my $search = $arghash->{searches} = {};
468 while ($query =~ s/((?:keyword(?:\|\w+)?|title(?:\|\w+)?|author(?:\|\w+)?|subject(?:\|\w+)?|series(?:\|\w+)?|site|dir|sort|lang|available):[^:]+)$//so) {
469 my($type, $value) = split(':', $1);
470 next unless $type and $value;
472 $value =~ s/^\s*//og;
473 $value =~ s/\s*$//og;
474 $type = 'sort_dir' if $type eq 'dir';
476 if($type eq 'site') {
477 # 'site' is the org shortname. when using this, we also want
478 # to search at the requested org's depth
479 my $e = new_editor();
480 if(my $org = $e->search_actor_org_unit({shortname => $value})->[0]) {
481 $arghash->{org_unit} = $org->id if $org;
482 $arghash->{depth} = $e->retrieve_actor_org_unit_type($org->ou_type)->depth;
484 $logger->warn("'site:' query used on invalid org shortname: $value ... ignoring");
487 } elsif($type eq 'available') {
489 $arghash->{available} = 1 unless $value eq 'false' or $value eq '0';
491 } elsif($type eq 'lang') {
492 # collect languages into an array of languages
493 $arghash->{language} = [] unless $arghash->{language};
494 push(@{$arghash->{language}}, $value);
497 # append the search term to the term under construction
498 $search->{$type} = {} unless $search->{$type};
499 $search->{$type}->{term} =
500 ($search->{$type}->{term}) ? $search->{$type}->{term} . " $value" : $value;
505 # This is the front part of the string before any special tokens were parsed.
506 # Add this data to the default search class
507 my $type = $arghash->{default_class} || 'keyword';
508 $search->{$type} = {} unless $search->{$type};
509 $search->{$type}->{term} =
510 ($search->{$type}->{term}) ? $search->{$type}->{term} . " $query" : $query;
513 # capture the original limit because the search method alters the limit internally
514 my $ol = $arghash->{limit};
516 (my $method = $self->api_name) =~ s/\.query//o;
517 $method = $self->method_lookup($method);
518 my ($data) = $method->run($arghash, $docache);
520 $arghash->{limit} = $ol if $ol;
521 $data->{compiled_search} = $arghash;
523 $logger->info("compiled search is " . OpenSRF::Utils::JSON->perl2JSON($arghash));
528 __PACKAGE__->register_method(
529 method => 'cat_search_z_style_wrapper',
530 api_name => 'open-ils.search.biblio.zstyle',
532 signature => q/@see open-ils.search.biblio.multiclass/);
534 sub cat_search_z_style_wrapper {
537 my $authtoken = shift;
540 my $cstore = OpenSRF::AppSession->connect('open-ils.cstore');
542 my $ou = $cstore->request(
543 'open-ils.cstore.direct.actor.org_unit.search',
544 { parent_ou => undef }
547 my $result = { service => 'native-evergreen-catalog', records => [] };
548 my $searchhash = { limit => $$args{limit}, offset => $$args{offset}, org_unit => $ou->id };
550 $$searchhash{searches}{title} = $$args{search}{title};
551 $$searchhash{searches}{author} = $$args{search}{author};
552 $$searchhash{searches}{subject} = $$args{search}{subject};
553 $$searchhash{searches}{keyword} = $$args{search}{keyword};
554 $$searchhash{searches}{keyword} .= ' '.$$args{search}{tcn};
555 $$searchhash{searches}{keyword} .= ' '.$$args{search}{isbn};
556 $$searchhash{searches}{keyword} .= ' '.$$args{search}{publisher};
557 $$searchhash{searches}{keyword} .= ' '.$$args{search}{pubdate};
558 $$searchhash{searches}{keyword} .= ' '.$$args{search}{item_type};
560 my $list = $self->the_quest_for_knowledge( $client, $searchhash );
562 if ($list->{count} > 0) {
563 $result->{count} = $list->{count};
565 my $records = $cstore->request(
566 'open-ils.cstore.direct.biblio.record_entry.search.atomic',
567 { id => [ map { ( $_->[0] ) } @{$list->{ids}} ] }
570 for my $rec ( @$records ) {
572 my $u = OpenILS::Utils::ModsParser->new();
573 $u->start_mods_batch( $rec->marc );
574 my $mods = $u->finish_mods_batch();
576 push @{ $result->{records} }, { mvr => $mods, marcxml => $rec->marc };
585 # ----------------------------------------------------------------------------
586 # These are the main OPAC search methods
587 # ----------------------------------------------------------------------------
589 __PACKAGE__->register_method(
590 method => 'the_quest_for_knowledge',
591 api_name => 'open-ils.search.biblio.multiclass',
593 Performs a multi class bilbli or metabib search
594 @param searchhash A search object layed out like so:
595 searches : { "$class" : "$value", ...}
596 org_unit : The org id to focus the search at
597 depth : The org depth
598 limit : The search limit
599 offset : The search offset
600 format : The MARC format
601 sort : What field to sort the results on [ author | title | pubdate ]
602 sort_dir : What direction do we sort? [ asc | desc ]
603 @return An object of the form
604 { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }
608 __PACKAGE__->register_method(
609 method => 'the_quest_for_knowledge',
610 api_name => 'open-ils.search.biblio.multiclass.staff',
611 signature => q/@see open-ils.search.biblio.multiclass/);
612 __PACKAGE__->register_method(
613 method => 'the_quest_for_knowledge',
614 api_name => 'open-ils.search.metabib.multiclass',
615 signature => q/@see open-ils.search.biblio.multiclass/);
616 __PACKAGE__->register_method(
617 method => 'the_quest_for_knowledge',
618 api_name => 'open-ils.search.metabib.multiclass.staff',
619 signature => q/@see open-ils.search.biblio.multiclass/);
621 sub the_quest_for_knowledge {
622 my( $self, $conn, $searchhash, $docache ) = @_;
624 return { count => 0 } unless $searchhash and
625 ref $searchhash->{searches} eq 'HASH';
627 my $method = 'open-ils.storage.biblio.multiclass.search_fts';
631 if($self->api_name =~ /metabib/) {
633 $method =~ s/biblio/metabib/o;
637 my $offset = $searchhash->{offset} || 0;
638 my $limit = $searchhash->{limit} || 10;
639 my $end = $offset + $limit - 1;
641 # do some simple sanity checking
642 if(!$searchhash->{searches} or
643 ( !grep { /^(?:title|author|subject|series|keyword)/ } keys %{$searchhash->{searches}} ) ) {
644 return { count => 0 };
649 $searchhash->{offset} = 0;
650 $searchhash->{limit} = $maxlimit;
652 return { count => 0 } if $offset > $maxlimit;
655 push( @search, ($_ => $$searchhash{$_})) for (sort keys %$searchhash);
656 my $s = OpenSRF::Utils::JSON->perl2JSON(\@search);
657 my $ckey = $pfx . md5_hex($method . $s);
659 $logger->info("bib search for: $s");
661 $searchhash->{limit} -= $offset;
665 my $result = ($docache) ? search_cache($ckey, $offset, $limit) : undef;
669 $method .= ".staff" if($self->api_name =~ /staff/);
670 $method .= ".atomic";
672 for (keys %$searchhash) {
673 delete $$searchhash{$_}
674 unless defined $$searchhash{$_};
677 $result = $U->storagereq( $method, %$searchhash );
684 return {count => 0} unless ($result && $$result[0]);
688 my $count = ($ismeta) ? $result->[0]->[3] : $result->[0]->[2];
691 # If we didn't get this data from the cache, put it into the cache
692 # then return the correct offset of records
693 $logger->debug("putting search cache $ckey\n");
694 put_cache($ckey, $count, \@recs);
698 # if we have the full set of data, trim out
699 # the requested chunk based on limit and offset
701 for ($offset..$end) {
702 last unless $recs[$_];
708 return { ids => \@recs, count => $count };
719 my $end = $offset + $limit - 1;
721 $logger->debug("searching cache for $key : $start..$end\n");
723 return undef unless $cache;
724 my $data = $cache->get_cache($key);
726 return undef unless $data;
728 my $count = $data->[0];
731 return undef unless $offset < $count;
735 for( my $i = $offset; $i <= $end; $i++ ) {
736 last unless my $d = $$data[$i];
740 $logger->debug("search_cache found ".scalar(@result)." items for count=$count, start=$start, end=$end");
747 my( $key, $count, $data ) = @_;
748 return undef unless $cache;
749 $logger->debug("search_cache putting ".
750 scalar(@$data)." items at key $key with timeout $cache_timeout");
751 $cache->put_cache($key, [ $count, $data ], $cache_timeout);
759 __PACKAGE__->register_method(
760 method => "biblio_mrid_to_modsbatch_batch",
761 api_name => "open-ils.search.biblio.metarecord.mods_slim.batch.retrieve");
763 sub biblio_mrid_to_modsbatch_batch {
764 my( $self, $client, $mrids) = @_;
765 warn "Performing mrid_to_modsbatch_batch...";
767 my $method = $self->method_lookup("open-ils.search.biblio.metarecord.mods_slim.retrieve");
768 for my $id (@$mrids) {
769 next unless defined $id;
770 my ($m) = $method->run($id);
777 __PACKAGE__->register_method(
778 method => "biblio_mrid_to_modsbatch",
779 api_name => "open-ils.search.biblio.metarecord.mods_slim.retrieve",
780 notes => <<" NOTES");
781 Returns the mvr associated with a given metarecod. If none exists,
785 __PACKAGE__->register_method(
786 method => "biblio_mrid_to_modsbatch",
787 api_name => "open-ils.search.biblio.metarecord.mods_slim.retrieve.staff",
788 notes => <<" NOTES");
789 Returns the mvr associated with a given metarecod. If none exists,
793 sub biblio_mrid_to_modsbatch {
794 my( $self, $client, $mrid, $args) = @_;
796 warn "Grabbing mvr for $mrid\n";
798 my ($mr, $evt) = _grab_metarecord($mrid);
799 return $evt unless $mr;
801 my $mvr = $self->biblio_mrid_check_mvr($client, $mr);
802 $mvr = $self->biblio_mrid_make_modsbatch( $client, $mr ) unless $mvr;
804 return $mvr unless ref($args);
806 # Here we find the lead record appropriate for the given filters
807 # and use that for the title and author of the metarecord
808 my $format = $$args{format};
809 my $org = $$args{org};
810 my $depth = $$args{depth};
812 return $mvr unless $format or $org or $depth;
814 my $method = "open-ils.storage.ordered.metabib.metarecord.records";
815 $method = "$method.staff" if $self->api_name =~ /staff/o;
817 my $rec = $U->storagereq($method, $format, $org, $depth, 1);
819 if( my $mods = $U->record_to_mvr($rec) ) {
821 $mvr->title($mods->title);
822 $mvr->title($mods->author);
823 $logger->debug("mods_slim updating title and ".
824 "author in mvr with ".$mods->title." : ".$mods->author);
830 # converts a metarecord to an mvr
833 my $perl = OpenSRF::Utils::JSON->JSON2perl($mr->mods());
834 return Fieldmapper::metabib::virtual_record->new($perl);
837 # checks to see if a metarecord has mods, if so returns true;
839 __PACKAGE__->register_method(
840 method => "biblio_mrid_check_mvr",
841 api_name => "open-ils.search.biblio.metarecord.mods_slim.check",
842 notes => <<" NOTES");
843 Takes a metarecord ID or a metarecord object and returns true
844 if the metarecord already has an mvr associated with it.
847 sub biblio_mrid_check_mvr {
848 my( $self, $client, $mrid ) = @_;
852 if(ref($mrid)) { $mr = $mrid; }
853 else { ($mr, $evt) = _grab_metarecord($mrid); }
856 warn "Checking mvr for mr " . $mr->id . "\n";
858 return _mr_to_mvr($mr) if $mr->mods();
862 sub _grab_metarecord {
864 #my $e = OpenILS::Utils::Editor->new;
865 my $e = new_editor();
866 my $mr = $e->retrieve_metabib_metarecord($mrid) or return ( undef, $e->event );
871 __PACKAGE__->register_method(
872 method => "biblio_mrid_make_modsbatch",
873 api_name => "open-ils.search.biblio.metarecord.mods_slim.create",
874 notes => <<" NOTES");
875 Takes either a metarecord ID or a metarecord object.
876 Forces the creations of an mvr for the given metarecord.
877 The created mvr is returned.
880 sub biblio_mrid_make_modsbatch {
881 my( $self, $client, $mrid ) = @_;
883 #my $e = OpenILS::Utils::Editor->new;
884 my $e = new_editor();
891 $mr = $e->retrieve_metabib_metarecord($mrid)
895 my $masterid = $mr->master_record;
896 $logger->info("creating new mods batch for metarecord=$mrid, master record=$masterid");
898 my $ids = $U->storagereq(
899 'open-ils.storage.ordered.metabib.metarecord.records.staff.atomic', $mrid);
900 return undef unless @$ids;
902 my $master = $e->retrieve_biblio_record_entry($masterid)
905 # start the mods batch
906 my $u = OpenILS::Utils::ModsParser->new();
907 $u->start_mods_batch( $master->marc );
909 # grab all of the sub-records and shove them into the batch
910 my @ids = grep { $_ ne $masterid } @$ids;
911 #my $subrecs = (@ids) ? $e->batch_retrieve_biblio_record_entry(\@ids) : [];
916 my $r = $e->retrieve_biblio_record_entry($i);
917 push( @$subrecs, $r ) if $r;
922 $logger->debug("adding record ".$_->id." to mods batch for metarecord=$mrid");
923 $u->push_mods_batch( $_->marc ) if $_->marc;
927 # finish up and send to the client
928 my $mods = $u->finish_mods_batch();
929 $mods->doc_id($mrid);
930 $client->respond_complete($mods);
933 # now update the mods string in the db
934 my $string = OpenSRF::Utils::JSON->perl2JSON($mods->decast);
937 #$e = OpenILS::Utils::Editor->new(xact => 1);
938 $e = new_editor(xact => 1);
939 $e->update_metabib_metarecord($mr)
940 or $logger->error("Error setting mods text on metarecord $mrid : " . Dumper($e->event));
949 # converts a mr id into a list of record ids
951 __PACKAGE__->register_method(
952 method => "biblio_mrid_to_record_ids",
953 api_name => "open-ils.search.biblio.metarecord_to_records",
956 __PACKAGE__->register_method(
957 method => "biblio_mrid_to_record_ids",
958 api_name => "open-ils.search.biblio.metarecord_to_records.staff",
961 sub biblio_mrid_to_record_ids {
962 my( $self, $client, $mrid, $args ) = @_;
964 my $format = $$args{format};
965 my $org = $$args{org};
966 my $depth = $$args{depth};
968 my $method = "open-ils.storage.ordered.metabib.metarecord.records.atomic";
969 $method =~ s/atomic/staff\.atomic/o if $self->api_name =~ /staff/o;
970 my $recs = $U->storagereq($method, $mrid, $format, $org, $depth);
972 return { count => scalar(@$recs), ids => $recs };
976 __PACKAGE__->register_method(
977 method => "biblio_record_to_marc_html",
978 api_name => "open-ils.search.biblio.record.html" );
980 my $parser = XML::LibXML->new();
981 my $xslt = XML::LibXSLT->new();
984 my $settings_client = OpenSRF::Utils::SettingsClient->new();
985 sub biblio_record_to_marc_html {
986 my( $self, $client, $recordid ) = @_;
989 my $dir = $settings_client->config_value( "dirs", "xsl" );
990 my $xsl = $settings_client->config_value(
991 "apps", "open-ils.search", "app_settings", "marc_html_xsl" );
993 $xsl = $parser->parse_file("$dir/$xsl");
994 $marc_sheet = $xslt->parse_stylesheet( $xsl );
998 my $record = $apputils->simple_scalar_request(
1000 "open-ils.cstore.direct.biblio.record_entry.retrieve",
1003 my $xmldoc = $parser->parse_string($record->marc);
1004 my $html = $marc_sheet->transform($xmldoc);
1005 $html = $html->toString();
1012 __PACKAGE__->register_method(
1013 method => "retrieve_all_copy_locations",
1014 api_name => "open-ils.search.config.copy_location.retrieve.all" );
1016 my $shelving_locations;
1017 sub retrieve_all_copy_locations {
1018 my( $self, $client ) = @_;
1019 if(!$shelving_locations) {
1020 $shelving_locations = $apputils->simple_scalar_request(
1022 "open-ils.cstore.direct.asset.copy_location.search.atomic",
1023 { id => { "!=" => undef } }
1026 return $shelving_locations;
1032 __PACKAGE__->register_method(
1033 method => "retrieve_all_copy_statuses",
1034 api_name => "open-ils.search.config.copy_status.retrieve.all" );
1037 sub retrieve_all_copy_statuses {
1038 my( $self, $client ) = @_;
1039 return $copy_statuses if $copy_statuses;
1040 return $copy_statuses =
1041 new_editor()->retrieve_all_config_copy_status();
1045 __PACKAGE__->register_method(
1046 method => "copy_counts_per_org",
1047 api_name => "open-ils.search.biblio.copy_counts.retrieve");
1049 __PACKAGE__->register_method(
1050 method => "copy_counts_per_org",
1051 api_name => "open-ils.search.biblio.copy_counts.retrieve.staff");
1053 sub copy_counts_per_org {
1054 my( $self, $client, $record_id ) = @_;
1056 warn "Retreiveing copy copy counts for record $record_id and method " . $self->api_name . "\n";
1058 my $method = "open-ils.storage.biblio.record_entry.global_copy_count.atomic";
1059 if($self->api_name =~ /staff/) { $method =~ s/atomic/staff\.atomic/; }
1061 my $counts = $apputils->simple_scalar_request(
1062 "open-ils.storage", $method, $record_id );
1064 $counts = [ sort {$a->[0] <=> $b->[0]} @$counts ];
1069 __PACKAGE__->register_method(
1070 method => "copy_count_summary",
1071 api_name => "open-ils.search.biblio.copy_counts.summary.retrieve",
1072 notes => <<" NOTES");
1073 returns an array of these:
1074 [ org_id, callnumber_label, <status1_count>, <status2_cout>,...]
1075 where statusx is a copy status name. the statuses are sorted
1079 sub copy_count_summary {
1080 my( $self, $client, $rid, $org, $depth ) = @_;
1083 my $data = $U->storagereq(
1084 'open-ils.storage.biblio.record_entry.status_copy_count.atomic', $rid, $org, $depth );
1086 return [ sort { $a->[1] cmp $b->[1] } @$data ];
1092 __PACKAGE__->register_method(
1093 method => "multiclass_search",
1094 api_name => "open-ils.search.biblio.multiclass",
1095 notes => <<" NOTES");
1096 Performs a multiclass search
1097 PARAMS( searchBlob, org_unit, format, limit )
1098 where searchBlob is defined like this:
1100 "title" : { "term" : "water" },
1101 "author" : { "term" : "smith" },
1106 __PACKAGE__->register_method(
1107 method => "multiclass_search",
1108 api_name => "open-ils.search.biblio.multiclass.staff",
1109 notes => "see open-ils.search.biblio.multiclass" );
1111 sub multiclass_search {
1112 my( $self, $client, $searchBlob, $orgid, $format, $limit ) = @_;
1114 $logger->debug("Performing multiclass search with org => $orgid, " .
1115 "format => $format, limit => $limit, and search blob " . Dumper($searchBlob));
1117 my $meth = 'open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.atomic';
1118 if($self->api_name =~ /staff/) { $meth =~ s/metarecord\.atomic/metarecord.staff.atomic/; }
1121 my $records = $apputils->simplereq(
1122 'open-ils.storage', $meth,
1123 org_unit => $orgid, searches => $searchBlob, format => $format, limit => $limit );
1128 if( ref($records) and $records->[0] and
1129 defined($records->[0]->[3])) { $count = $records->[0]->[3];}
1131 for my $r (@$records) { push( @$recs, $r ) if ($r and $r->[0]); }
1133 # records has the form: [ mrid, rank, singleRecord / 0, hitCount ];
1134 return { ids => $recs, count => $count };
1140 __PACKAGE__->register_method(
1141 method => "multiclass_search",
1142 api_name => "open-ils.search.biblio.multiclass",
1144 Performs a multiclass search
1145 @param args A names hash of arguments:
1146 org_unit : The org to focus the search on
1147 depth : The search depth
1148 format : Item format
1149 limit : Return limit
1150 offset : Search offset
1151 searches : A named hash of searches which has the following format:
1153 "title" : { "term" : "water" },
1154 "author" : { "term" : "smith" },
1157 @return { ids : <array of ids>, count : hitcount }
1161 __PACKAGE__->register_method(
1162 method => "multiclass_search",
1163 api_name => "open-ils.search.biblio.multiclass.staff",
1164 notes => q/@see open-ils.search.biblio.multiclass/ );
1166 sub multiclass_search {
1167 my( $self, $client, $args ) = @_;
1169 $logger->debug("Performing multiclass search with args:\n" . Dumper($args));
1170 my $meth = 'open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.atomic';
1171 if($self->api_name =~ /staff/) { $meth =~ s/metarecord\.atomic/metarecord.staff.atomic/; }
1173 my $records = $apputils->simplereq( 'open-ils.storage', $meth, %$args );
1178 if( ref($records) and $records->[0] and
1179 defined($records->[0]->[3])) { $count = $records->[0]->[3];}
1181 for my $r (@$records) { push( @$recs, $r ) if ($r and $r->[0]); }
1183 return { ids => $recs, count => $count };
1190 __PACKAGE__->register_method(
1191 method => "marc_search",
1192 api_name => "open-ils.search.biblio.marc.staff");
1194 __PACKAGE__->register_method(
1195 method => "marc_search",
1196 api_name => "open-ils.search.biblio.marc",
1197 notes => <<" NOTES");
1199 open-ils.storage.biblio.full_rec.multi_search.atomic
1200 { "searches": [{"term":"harry","restrict": [{"tag":245,"subfield":"a"}]}], "org_unit": 1,
1201 "limit":5,"sort":"author","item_type":"g"}
1205 my( $self, $conn, $args, $limit, $offset ) = @_;
1207 my $method = 'open-ils.storage.biblio.full_rec.multi_search';
1208 $method .= ".staff" if $self->api_name =~ /staff/;
1209 $method .= ".atomic";
1215 push( @search, ($_ => $$args{$_}) ) for (sort keys %$args);
1216 my $ckey = $pfx . md5_hex($method . OpenSRF::Utils::JSON->perl2JSON(\@search));
1218 my $recs = search_cache($ckey, $offset, $limit);
1221 $recs = $U->storagereq($method, %$args) || [];
1223 put_cache($ckey, scalar(@$recs), $recs);
1224 $recs = [ @$recs[$offset..($offset + ($limit - 1))] ];
1231 $count = $recs->[0]->[2] if $recs->[0] and $recs->[0]->[2];
1232 my @recs = map { $_->[0] } @$recs;
1234 return { ids => \@recs, count => $count };
1238 __PACKAGE__->register_method(
1239 method => "biblio_search_isbn",
1240 api_name => "open-ils.search.biblio.isbn",
1243 sub biblio_search_isbn {
1244 my( $self, $client, $isbn ) = @_;
1245 $logger->debug("Searching ISBN $isbn");
1246 my $e = new_editor();
1247 my $recs = $U->storagereq(
1248 'open-ils.storage.id_list.biblio.record_entry.search.isbn.atomic', $isbn );
1249 return { ids => $recs, count => scalar(@$recs) };
1253 __PACKAGE__->register_method(
1254 method => "biblio_search_issn",
1255 api_name => "open-ils.search.biblio.issn",
1258 sub biblio_search_issn {
1259 my( $self, $client, $issn ) = @_;
1260 $logger->debug("Searching ISSN $issn");
1261 my $e = new_editor();
1262 my $recs = $U->storagereq(
1263 'open-ils.storage.id_list.biblio.record_entry.search.issn.atomic', $issn );
1264 return { ids => $recs, count => scalar(@$recs) };
1270 __PACKAGE__->register_method(
1271 method => "fetch_mods_by_copy",
1272 api_name => "open-ils.search.biblio.mods_from_copy",
1275 sub fetch_mods_by_copy {
1276 my( $self, $client, $copyid ) = @_;
1277 my ($record, $evt) = $apputils->fetch_record_by_copy( $copyid );
1278 return $evt if $evt;
1279 return OpenILS::Event->new('ITEM_NOT_CATALOGED') unless $record->marc;
1280 return $apputils->record_to_mvr($record);
1285 # -------------------------------------------------------------------------------------
1287 __PACKAGE__->register_method(
1288 method => "cn_browse",
1289 api_name => "open-ils.search.callnumber.browse.target",
1290 notes => "Starts a callnumber browse"
1293 __PACKAGE__->register_method(
1294 method => "cn_browse",
1295 api_name => "open-ils.search.callnumber.browse.page_up",
1296 notes => "Returns the previous page of callnumbers",
1299 __PACKAGE__->register_method(
1300 method => "cn_browse",
1301 api_name => "open-ils.search.callnumber.browse.page_down",
1302 notes => "Returns the next page of callnumbers",
1306 # RETURNS array of arrays like so: label, owning_lib, record, id
1308 my( $self, $client, @params ) = @_;
1311 $method = 'open-ils.storage.asset.call_number.browse.target.atomic'
1312 if( $self->api_name =~ /target/ );
1313 $method = 'open-ils.storage.asset.call_number.browse.page_up.atomic'
1314 if( $self->api_name =~ /page_up/ );
1315 $method = 'open-ils.storage.asset.call_number.browse.page_down.atomic'
1316 if( $self->api_name =~ /page_down/ );
1318 return $apputils->simplereq( 'open-ils.storage', $method, @params );
1320 # -------------------------------------------------------------------------------------
1322 __PACKAGE__->register_method(
1323 method => "fetch_cn",
1324 api_name => "open-ils.search.callnumber.retrieve",
1325 notes => "retrieves a callnumber based on ID",
1329 my( $self, $client, $id ) = @_;
1330 my( $cn, $evt ) = $apputils->fetch_callnumber( $id );
1331 return $evt if $evt;
1335 __PACKAGE__->register_method (
1336 method => "fetch_copy_by_cn",
1337 api_name => 'open-ils.search.copies_by_call_number.retrieve',
1339 Returns an array of copy id's by callnumber id
1340 @param cnid The callnumber id
1341 @return An array of copy ids
1345 sub fetch_copy_by_cn {
1346 my( $self, $conn, $cnid ) = @_;
1347 return $U->cstorereq(
1348 'open-ils.cstore.direct.asset.copy.id_list.atomic',
1349 { call_number => $cnid, deleted => 'f' } );
1352 __PACKAGE__->register_method (
1353 method => 'fetch_cn_by_info',
1354 api_name => 'open-ils.search.call_number.retrieve_by_info',
1356 @param label The callnumber label
1357 @param record The record the cn is attached to
1358 @param org The owning library of the cn
1359 @return The callnumber object
1364 sub fetch_cn_by_info {
1365 my( $self, $conn, $label, $record, $org ) = @_;
1366 return $U->cstorereq(
1367 'open-ils.cstore.direct.asset.call_number.search',
1368 { label => $label, record => $record, owning_lib => $org, deleted => 'f' });
1375 __PACKAGE__->register_method (
1376 method => 'bib_extras',
1377 api_name => 'open-ils.search.biblio.lit_form_map.retrieve.all');
1378 __PACKAGE__->register_method (
1379 method => 'bib_extras',
1380 api_name => 'open-ils.search.biblio.item_form_map.retrieve.all');
1381 __PACKAGE__->register_method (
1382 method => 'bib_extras',
1383 api_name => 'open-ils.search.biblio.item_type_map.retrieve.all');
1384 __PACKAGE__->register_method (
1385 method => 'bib_extras',
1386 api_name => 'open-ils.search.biblio.audience_map.retrieve.all');
1391 my $e = new_editor();
1393 return $e->retrieve_all_config_lit_form_map()
1394 if( $self->api_name =~ /lit_form/ );
1396 return $e->retrieve_all_config_item_form_map()
1397 if( $self->api_name =~ /item_form_map/ );
1399 return $e->retrieve_all_config_item_type_map()
1400 if( $self->api_name =~ /item_type_map/ );
1402 return $e->retrieve_all_config_audience_map()
1403 if( $self->api_name =~ /audience_map/ );
1410 __PACKAGE__->register_method(
1411 method => 'fetch_slim_record',
1412 api_name => 'open-ils.search.biblio.record_entry.slim.retrieve',
1414 Returns a biblio.record_entry without the attached marcxml
1418 sub fetch_slim_record {
1419 my( $self, $conn, $ids ) = @_;
1421 #my $editor = OpenILS::Utils::Editor->new;
1422 my $editor = new_editor();
1425 return $editor->event unless
1426 my $r = $editor->retrieve_biblio_record_entry($_);
1435 __PACKAGE__->register_method(
1436 method => 'rec_to_mr_rec_descriptors',
1437 api_name => 'open-ils.search.metabib.record_to_descriptors',
1439 specialized method...
1440 Given a biblio record id or a metarecord id,
1441 this returns a list of metabib.record_descriptor
1442 objects that live within the same metarecord
1443 @param args Object of args including:
1447 sub rec_to_mr_rec_descriptors {
1448 my( $self, $conn, $args ) = @_;
1450 my $rec = $$args{record};
1451 my $mrec = $$args{metarecord};
1452 my $item_forms = $$args{item_forms};
1453 my $item_types = $$args{item_types};
1454 my $item_lang = $$args{item_lang};
1456 my $e = new_editor();
1460 my $map = $e->search_metabib_metarecord_source_map({source => $rec});
1461 return $e->event unless @$map;
1462 $mrec = $$map[0]->metarecord;
1465 $recs = $e->search_metabib_metarecord_source_map({metarecord => $mrec});
1466 return $e->event unless @$recs;
1468 my @recs = map { $_->source } @$recs;
1469 my $search = { record => \@recs };
1470 $search->{item_form} = $item_forms if $item_forms and @$item_forms;
1471 $search->{item_type} = $item_types if $item_types and @$item_types;
1472 $search->{item_lang} = $item_lang if $item_lang;
1474 my $desc = $e->search_metabib_record_descriptor($search);
1476 return { metarecord => $mrec, descriptors => $desc };
1482 __PACKAGE__->register_method(
1483 method => 'copies_created_on',
1487 sub copies_created_on {
1488 my( $self, $conn, $auth, $org, $date ) = @_;
1489 my $e = new_editor(authtoken=>$auth);
1490 return $e->event unless $e->checkauth;
1494 __PACKAGE__->register_method(
1495 method => 'fetch_age_protect',
1496 api_name => 'open-ils.search.copy.age_protect.retrieve.all',
1499 sub fetch_age_protect {
1500 return new_editor()->retrieve_all_config_rule_age_hold_protect();
1504 __PACKAGE__->register_method(
1505 method => 'copies_by_cn_label',
1506 api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label',
1509 __PACKAGE__->register_method(
1510 method => 'copies_by_cn_label',
1511 api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label.staff',
1514 sub copies_by_cn_label {
1515 my( $self, $conn, $record, $label, $circ_lib ) = @_;
1516 my $e = new_editor();
1517 my $cns = $e->search_asset_call_number({record => $record, label => $label, deleted => 'f'}, {idlist=>1});
1518 return [] unless @$cns;
1520 # show all non-deleted copies in the staff client ...
1521 if ($self->api_name =~ /staff$/o) {
1522 return $e->search_asset_copy({call_number => $cns, circ_lib => $circ_lib, deleted => 'f'}, {idlist=>1});
1525 # ... otherwise, grab the copies ...
1526 my $copies = $e->search_asset_copy(
1527 [ {call_number => $cns, circ_lib => $circ_lib, deleted => 'f', opac_visible => 't'},
1528 {flesh => 1, flesh_fields => { acp => [ qw/location status/] } }
1532 # ... and test for location and status visibility
1533 return [ map { ($U->is_true($_->location->opac_visible) && $U->is_true($_->status->holdable)) ? ($_->id) : () } @$copies ];