1 package OpenILS::Application::Search::Biblio;
2 use base qw/OpenSRF::Application/;
3 use strict; use warnings;
6 use OpenILS::Utils::Fieldmapper;
7 use OpenILS::Utils::ModsParser;
8 use OpenSRF::Utils::SettingsClient;
10 use OpenILS::Application::AppUtils;
14 use Time::HiRes qw(time);
15 use OpenSRF::EX qw(:try);
16 use Digest::MD5 qw(md5_hex);
21 my $apputils = "OpenILS::Application::AppUtils";
23 # Houses biblio search utilites
25 __PACKAGE__->register_method(
26 method => "biblio_search_marc",
27 api_name => "open-ils.search.biblio.marc",
29 note => "Searches biblio information by marc tag",
32 sub biblio_search_marc {
34 my( $self, $client, $search_hash, $string ) = @_;
36 warn "Building biblio marc session\n";
37 my $session = OpenSRF::AppSession->create("open-ils.storage");
40 warn "Sending biblio marc request. String $string\nSearch hash: " . Dumper($search_hash);
41 my $request = $session->request(
42 "open-ils.storage.direct.metabib.full_rec.search_fts.index_vector.atomic",
43 restrict => $search_hash,
45 my $data = $request->gather(1);
50 $session->disconnect();
58 # ---------------------------------------------------------------------------
59 # takes a list of record id's and turns the docs into friendly
60 # mods structures. Creates one MODS structure for each doc id.
61 # ---------------------------------------------------------------------------
62 sub _records_to_mods {
68 my $session = OpenSRF::AppSession->create("open-ils.storage");
69 my $request = $session->request(
70 "open-ils.storage.direct.biblio.record_entry.batch.retrieve", @ids );
72 my $last_content = undef;
74 while( my $response = $request->recv() ) {
77 my $u = OpenILS::Utils::ModsParser->new();
78 $u->start_mods_batch( $last_content->marc );
79 my $mods = $u->finish_mods_batch();
80 $mods->doc_id($last_content->id());
81 warn "Turning doc " . $mods->doc_id() . " into MODS\n";
82 $last_content = undef;
86 next unless $response;
88 if($response->isa("OpenSRF::EX")) {
89 throw $response ($response->stringify);
92 $last_content = $response->content;
97 my $u = OpenILS::Utils::ModsParser->new();
98 $u->start_mods_batch( $last_content->marc );
99 my $mods = $u->finish_mods_batch();
100 $mods->doc_id($last_content->id());
101 push @results, $mods;
106 $session->disconnect();
112 __PACKAGE__->register_method(
113 method => "record_id_to_mods",
114 api_name => "open-ils.search.biblio.record.mods.retrieve",
116 note => "Provide ID, we provide the mods"
119 # converts a record into a mods object with copy counts attached
120 sub record_id_to_mods {
122 my( $self, $client, $org_id, $id ) = @_;
124 my $mods_list = _records_to_mods( $id );
125 my $mods_obj = $mods_list->[0];
126 my $cmethod = $self->method_lookup(
127 "open-ils.search.biblio.record.copy_count");
128 my ($count) = $cmethod->run($org_id, $id);
129 $mods_obj->copy_count($count);
135 __PACKAGE__->register_method(
136 method => "record_id_to_mods_slim",
137 api_name => "open-ils.search.biblio.record.mods_slim.retrieve",
139 note => "Provide ID, we provide the mods"
142 # converts a record into a mods object with NO copy counts attached
143 sub record_id_to_mods_slim {
145 my( $self, $client, $id ) = @_;
146 warn "Retrieving MODS object for record $id\n";
147 return undef unless(defined $id);
149 my $mods_list = _records_to_mods( $id );
150 my $mods_obj = $mods_list->[0];
155 # Returns the number of copies attached to a record based on org location
156 __PACKAGE__->register_method(
157 method => "record_id_to_copy_count",
158 api_name => "open-ils.search.biblio.record.copy_count",
161 __PACKAGE__->register_method(
162 method => "record_id_to_copy_count",
163 api_name => "open-ils.search.biblio.metarecord.copy_count",
165 sub record_id_to_copy_count {
166 my( $self, $client, $org_id, $record_id ) = @_;
168 my $method = "open-ils.storage.biblio.record_entry.copy_count.atomic";
170 if($self->api_name =~ /metarecord/) {
171 $method = "open-ils.storage.metabib.metarecord.copy_count.atomic";
175 my $session = OpenSRF::AppSession->create("open-ils.storage");
176 warn "copy_count retrieve $record_id\n";
177 return undef unless(defined $record_id);
179 my $request = $session->request(
180 $method, org_unit => $org_id => $key => $record_id );
183 my $count = $request->gather(1);
184 $session->disconnect();
185 return [ sort { $a->{depth} <=> $b->{depth} } @$count ];
190 # used for cat search classes
191 my $cat_search_hash = {
194 { tag => "100", subfield => "a"} ,
195 { tag => "700", subfield => "a"},
199 { tag => "245", subfield => "a"},
200 { tag => "242", subfield => "a"},
201 { tag => "240", subfield => "a"},
202 { tag => "210", subfield => "a"},
206 { tag => "650", subfield => "_" },
210 { tag => "035", subfield => "_" },
214 { tag => "020", subfield => "a" },
220 __PACKAGE__->register_method(
221 method => "biblio_search_tcn",
222 api_name => "open-ils.search.biblio.tcn",
224 note => "Retrieve a record by TCN",
227 sub biblio_search_tcn {
229 my( $self, $client, $tcn ) = @_;
231 $tcn =~ s/.*?(\w+)\s*$/$1/o;
232 warn "Searching TCN $tcn\n";
234 my $session = OpenSRF::AppSession->create( "open-ils.storage" );
235 my $request = $session->request(
236 "open-ils.storage.direct.biblio.record_entry.search.tcn_value", $tcn );
237 my $response = $request->recv();
240 unless ($response) { return []; }
242 if(UNIVERSAL::isa($response,"OpenSRF::EX")) {
243 warn "Received exception for tcn search\n";
244 throw $response ($response->stringify);
247 my $record_entry = $response->content;
249 for my $record (@$record_entry) {
250 push @ids, $record->id;
253 warn "received ID's for tcn search @ids\n";
256 return { count => $size, ids => \@ids };
261 # --------------------------------------------------------------------------------
264 __PACKAGE__->register_method(
265 method => "biblio_search_isbn",
266 api_name => "open-ils.search.biblio.isbn",
269 sub biblio_search_isbn {
270 my( $self, $client, $isbn ) = @_;
271 throw OpenSRF::EX::InvalidArg
273 ("biblio_search_isbn needs an ISBN to search")
274 unless defined $isbn;
276 warn "biblio search for ISBN $isbn\n";
277 my $method = $self->method_lookup("open-ils.search.biblio.marc");
278 my ($records) = $method->run( $cat_search_hash->{isbn}, $isbn );
281 for my $i (@$records) {
288 my $size = @$records;
289 return { count => $size, ids => $records };
294 # --------------------------------------------------------------------------------
296 __PACKAGE__->register_method(
297 method => "biblio_barcode_to_copy",
298 api_name => "open-ils.search.asset.copy.find_by_barcode",
301 # turns a barcode into a copy object
302 sub biblio_barcode_to_copy {
303 my( $self, $client, $barcode ) = @_;
305 throw OpenSRF::EX::InvalidArg
306 ("search.biblio.barcode needs a barcode to search")
307 unless defined $barcode;
309 warn "copy search for barcode $barcode\n";
310 my $record = OpenILS::Application::AppUtils->simple_scalar_request(
312 "open-ils.storage.direct.asset.copy.search.barcode",
315 return undef unless($record);
320 __PACKAGE__->register_method(
321 method => "biblio_barcode_to_title",
322 api_name => "open-ils.search.biblio.find_by_barcode",
325 sub biblio_barcode_to_title {
326 my( $self, $client, $barcode ) = @_;
329 throw OpenSRF::EX::ERROR
330 ("Not enough args to find_by_barcode");
333 my $title = $apputils->simple_scalar_request(
335 "open-ils.storage.biblio.record_entry.retrieve_by_barcode",
338 return { ids => $title->id, count => 1 };
341 my $u = OpenILS::Utils::ModsParser->new();
342 $u->start_mods_batch( $title->marc );
343 my $mods = $u->finish_mods_batch();
344 $mods->doc_id($title->id());
351 __PACKAGE__->register_method(
352 method => "biblio_copy_to_mods",
353 api_name => "open-ils.search.biblio.copy.mods.retrieve",
356 # takes a copy object and returns it fleshed mods object
357 sub biblio_copy_to_mods {
358 my( $self, $client, $copy ) = @_;
360 throw OpenSRF::EX::InvalidArgs
361 ("copy.mods.retrieve needs a copy") unless( $copy );
363 new Fieldmapper::asset::copy($copy);
365 my $volume = OpenILS::Application::AppUtils->simple_scalar_request(
367 "open-ils.storage.direct.asset.call_number.retrieve",
368 $copy->call_number() );
370 my $mods = _records_to_mods($volume->record());
371 $mods = shift @$mods;
372 $volume->copies([$copy]);
373 push @{$mods->call_numbers()}, $volume;
379 sub barcode_to_mods {
384 # --------------------------------------------------------------------------------
386 __PACKAGE__->register_method(
387 method => "cat_biblio_search_class",
388 api_name => "open-ils.search.cat.biblio.class",
390 note => "Searches biblio information by search class",
393 sub cat_biblio_search_class {
395 my( $self, $client, $org_id, $class, $sort, $string ) = @_;
397 throw OpenSRF::EX::InvalidArg
398 ("Not enough args to open-ils.search.cat.biblio.class")
399 unless( defined($org_id) and $class and $sort and $string );
404 my $method = $self->method_lookup("open-ils.search.biblio.marc");
406 throw OpenSRF::EX::PANIC
407 ("Can't lookup method 'open-ils.search.biblio.marc'");
410 my ($records) = $method->run( $cat_search_hash->{$class}, $string );
413 for my $i (@$records) { push @ids, $i->[0]; }
415 my $mods_list = _records_to_mods( @ids );
416 return undef unless (ref($mods_list) eq "ARRAY");
418 # ---------------------------------------------------------------
419 # append copy count information to the mods objects
420 my $session = OpenSRF::AppSession->create("open-ils.storage");
422 my $request = $session->request(
423 "open-ils.storage.direct.biblio.record_copy_count.batch", $org_id, @ids );
427 warn "receiving copy counts for doc $id\n";
429 my $response = $request->recv();
430 next unless $response;
432 if( $response and UNIVERSAL::isa($response, "Error")) {
433 throw $response ($response->stringify);
436 my $count = $response->content;
437 my $mods_obj = undef;
438 for my $m (@$mods_list) {
439 $mods_obj = $m if ($m->doc_id() == $id)
442 $mods_obj->copy_count($count);
445 $client->respond( $mods_obj );
451 $session->disconnect();
453 # ---------------------------------------------------------------
460 __PACKAGE__->register_method(
461 method => "cat_biblio_search_class_id",
462 api_name => "open-ils.search.cat.biblio.class.id",
464 note => "Searches biblio information by search class and returns the IDs",
467 sub cat_biblio_search_class_id {
469 my( $self, $client, $org_id, $class, $string, $limit, $offset ) = @_;
476 $string = OpenILS::Application::Search->filter_search($string);
477 if(!$string) { return undef; }
479 warn "Searching cat.biblio.class.id string: $string offset: $offset limit: $limit\n";
481 throw OpenSRF::EX::InvalidArg
482 ("Not enough args to open-ils.search.cat.biblio.class")
483 unless( defined($org_id) and $class and $string );
488 my $cache_key = md5_hex( $org_id . $class . $string );
489 my $id_array = OpenILS::Application::SearchCache->get_cache($cache_key);
492 warn "Returning class search from cache\n";
493 my $size = @$id_array;
494 my @ids = @$id_array[ $offset..($offset+$limit) ];
495 return { count => $size, ids => \@ids };
498 my $method = $self->method_lookup("open-ils.search.biblio.marc");
500 throw OpenSRF::EX::PANIC
501 ("Can't lookup method 'open-ils.search.biblio.marc'");
504 my ($records) = $method->run( $cat_search_hash->{$class}, $string );
508 for my $i (@$records) {
509 if(defined($i->[0])) {
510 push @cache_ids, $i->[0];
514 my @ids = @cache_ids[ $offset..($offset+$limit) ];
515 my $size = @$records;
517 OpenILS::Application::SearchCache->put_cache(
518 $cache_key, \@cache_ids, $size );
520 return { count =>$size, ids => \@ids };
525 __PACKAGE__->register_method(
526 method => "biblio_search_class",
527 api_name => "open-ils.search.biblio.class",
529 note => "Searches biblio information by search class and returns the IDs",
532 sub biblio_search_class {
534 my( $self, $client, $class, $string,
535 $org_id, $org_type, $limit, $offset ) = @_;
537 warn "org: $org_id : depth: $org_type : limit: $limit : offset: $offset\n";
540 $limit = 100 unless defined($limit and $limit > 0 );
541 $org_id = "1" unless defined($org_id); # xxx
542 $org_type = 0 unless defined($org_type);
544 warn "Searching biblio.class.id\n" .
546 "\noffset: $offset\n" .
548 "org_id: $org_id\n" .
549 "depth: $org_type\n" ;
551 $string = OpenILS::Application::Search->filter_search($string);
552 if(!$string) { return undef; }
554 if( !defined($org_id) or !$class or !$string ) {
555 warn "not enbough args to metarecord search\n";
556 throw OpenSRF::EX::InvalidArg
557 ("Not enough args to open-ils.search.cat.biblio.class")
562 if( ($class ne "title") and ($class ne "author") and
563 ($class ne "subject") and ($class ne "keyword") ) {
564 warn "Invalid search class: $class\n";
565 throw OpenSRF::EX::InvalidArg ("Not a valid search class: $class")
568 # grab the mr id's from storage
570 my $method = "open-ils.storage.metabib.$class.search_fts.metarecord_count";
571 warn "Performing count method $method\n";
572 my $session = OpenSRF::AppSession->create('open-ils.storage');
574 my $request = $session->request( $method,
579 my $response = $request->recv();
581 if(UNIVERSAL::isa($response, "OpenSRF::EX")) {
582 throw $response ($response->stringify);
585 my $count = $response->content;
586 warn "Received count $count\n";
587 # XXX check count size and respond accordingly
590 $request = $session->request(
591 #"open-ils.storage.cachable.metabib.$class.search_fts.metarecord.atomic",
592 "open-ils.storage.cachable.metabib.$class.search_fts.metarecord.atomic",
600 $response = $request->recv();
602 if(UNIVERSAL::isa($response, "OpenSRF::EX")) {
603 warn "Recieved Exception from storage: " . $response->stringify . "\n";
604 $response->{'msg'} = $response->stringify();
605 throw $response ($response->stringify);
609 my $records = $response->content;
613 # if we just get one, it won't be wrapped in an array
614 if(!ref($records->[0])) {
615 $records = [$records];
618 for my $i (@$records) {
624 #my @ids = @all_ids[ $offset..($offset+$limit) ];
626 @ids = grep { defined($_->[0]) } @ids;
630 $session->disconnect();
632 return { count =>$count, ids => \@ids };
639 __PACKAGE__->register_method(
640 method => "biblio_mrid_to_modsbatch",
641 api_name => "open-ils.search.biblio.metarecord.mods_slim.retrieve",
644 sub biblio_mrid_to_modsbatch {
645 my( $self, $client, $mrid ) = @_;
647 throw OpenSRF::EX::InvalidArg
648 ("search.biblio.metarecord_to_mods requires mr id")
649 unless defined( $mrid );
652 my $metarecord = OpenILS::Application::AppUtils->simple_scalar_request( "open-ils.storage",
653 "open-ils.storage.direct.metabib.metarecord.retrieve", $mrid );
656 throw OpenSRF::EX::ERROR ("No metarecord exists with the given id: $mrid");
659 my $master_id = $metarecord->master_record();
662 # check for existing mods
663 if($metarecord->mods()){
664 warn "We already have mods for " . $metarecord->id . "\n";
665 my $perl = JSON->JSON2perl($metarecord->mods());
666 return Fieldmapper::metabib::virtual_record->new($perl);
671 warn "Creating mods batch for metarecord $mrid\n";
672 my $id_hash = biblio_mrid_to_record_ids( undef, undef, $mrid );
673 my @ids = @{$id_hash->{ids}};
675 if(@ids < 1) { return undef; }
677 warn "Master ID is $master_id\n";
678 # grab the master record to start the mods batch
680 my $record = OpenILS::Application::AppUtils->simple_scalar_request( "open-ils.storage",
681 "open-ils.storage.direct.biblio.record_entry.retrieve", $master_id );
684 throw OpenSRF::EX::ERROR
685 ("No record returned with id $master_id");
688 my $u = OpenILS::Utils::ModsParser->new();
690 $u->start_mods_batch( $record->marc );
691 my $main_doc_id = $record->id();
693 @ids = grep { $_ ne $master_id } @ids;
695 # now we have to collect all of the marc objects and push them into a mods batch
696 my $session = OpenSRF::AppSession->create("open-ils.storage");
697 my $request = $session->request(
698 "open-ils.storage.direct.biblio.record_entry.batch.retrieve", @ids );
700 while( my $response = $request->recv() ) {
702 next unless $response;
703 if(UNIVERSAL::isa( $response,"OpenSRF::EX")) {
704 throw $response ($response->stringify);
707 my $content = $response->content;
710 $u->push_mods_batch( $content->marc );
714 my $mods = $u->finish_mods_batch();
715 $mods->doc_id($mrid);
718 $client->respond_complete($mods);
720 my $mods_string = JSON->perl2JSON($mods->decast);
722 $metarecord->mods($mods_string);
724 my $req = $session->request(
725 "open-ils.storage.direct.metabib.metarecord.update",
732 $session->disconnect();
740 # converts a mr id into a list of record ids
742 __PACKAGE__->register_method(
743 method => "biblio_mrid_to_record_ids",
744 api_name => "open-ils.search.biblio.metarecord_to_records",
747 sub biblio_mrid_to_record_ids {
748 my( $self, $client, $mrid ) = @_;
750 throw OpenSRF::EX::InvalidArg
751 ("search.biblio.metarecord_to_record_ids requires mr id")
752 unless defined( $mrid );
754 warn "Searching for record for MR $mrid\n";
756 my $mrmaps = OpenILS::Application::AppUtils->simple_scalar_request( "open-ils.storage",
757 "open-ils.storage.direct.metabib.metarecord_source_map.search.metarecord", $mrid );
760 for my $map (@$mrmaps) { push @ids, $map->source(); }
762 warn "Recovered id's [@ids] for mr $mrid\n";
766 return { count => $size, ids => \@ids };
771 __PACKAGE__->register_method(
772 method => "biblio_record_to_marc_html",
773 api_name => "open-ils.search.biblio.record.html" );
775 my $parser = XML::LibXML->new();
776 my $xslt = XML::LibXSLT->new();
777 my $xslt_doc = $parser->parse_file(
778 "/pines/cvs/ILS/Open-ILS/xsl/MARC21slim2HTML.xsl");
779 my $marc_sheet = $xslt->parse_stylesheet( $xslt_doc );
782 sub biblio_record_to_marc_html {
783 my( $self, $client, $recordid ) = @_;
786 my $record = $apputils->simple_scalar_request(
788 "open-ils.storage.direct.biblio.record_entry.retrieve",
791 my $xmldoc = $parser->parse_string($record->marc);
792 my $html = $marc_sheet->transform($xmldoc);
793 $html = $html->toString();
800 __PACKAGE__->register_method(
801 method => "retrieve_all_copy_locations",
802 api_name => "open-ils.search.config.copy_location.retreive.all" );
804 my $shelving_locations;
805 sub retrieve_all_copy_locations {
806 my( $self, $client ) = @_;
807 if(!$shelving_locations) {
808 $shelving_locations = $apputils->simple_scalar_request(
810 "open-ils.storage.direct.asset.copy_location.retrieve.all.atomic");
812 return $shelving_locations;