1 package OpenILS::Application::Search::Biblio;
2 use base qw/OpenSRF::Application/;
3 use strict; use warnings;
8 use OpenILS::Utils::Fieldmapper;
9 use OpenILS::Utils::ModsParser;
10 use OpenSRF::Utils::SettingsClient;
12 use OpenILS::Application::AppUtils;
16 use Time::HiRes qw(time);
17 use OpenSRF::EX qw(:try);
18 use Digest::MD5 qw(md5_hex);
23 my $apputils = "OpenILS::Application::AppUtils";
25 # Houses biblio search utilites
27 __PACKAGE__->register_method(
28 method => "biblio_search_marc",
29 api_name => "open-ils.search.biblio.marc",
31 note => "Searches biblio information by marc tag",
34 sub biblio_search_marc {
36 my( $self, $client, $search_hash, $string ) = @_;
38 warn "Building biblio marc session\n";
39 my $session = OpenSRF::AppSession->create("open-ils.storage");
42 warn "Sending biblio marc request. String $string\nSearch hash: " . Dumper($search_hash);
43 my $request = $session->request(
44 "open-ils.storage.direct.metabib.full_rec.search_fts.index_vector.atomic",
45 restrict => $search_hash,
47 my $data = $request->gather(1);
52 $session->disconnect();
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.storage");
71 my $request = $session->request(
72 "open-ils.storage.direct.biblio.record_entry.batch.retrieve", @ids );
74 my $last_content = undef;
76 while( my $response = $request->recv() ) {
79 my $u = OpenILS::Utils::ModsParser->new();
80 $u->start_mods_batch( $last_content->marc );
81 my $mods = $u->finish_mods_batch();
82 $mods->doc_id($last_content->id());
83 warn "Turning doc " . $mods->doc_id() . " into MODS\n";
84 $last_content = undef;
88 next unless $response;
90 if($response->isa("OpenSRF::EX")) {
91 throw $response ($response->stringify);
94 $last_content = $response->content;
99 my $u = OpenILS::Utils::ModsParser->new();
100 $u->start_mods_batch( $last_content->marc );
101 my $mods = $u->finish_mods_batch();
102 $mods->doc_id($last_content->id());
103 push @results, $mods;
108 $session->disconnect();
114 __PACKAGE__->register_method(
115 method => "record_id_to_mods",
116 api_name => "open-ils.search.biblio.record.mods.retrieve",
118 note => "Provide ID, we provide the mods"
121 # converts a record into a mods object with copy counts attached
122 sub record_id_to_mods {
124 my( $self, $client, $org_id, $id ) = @_;
126 my $mods_list = _records_to_mods( $id );
127 my $mods_obj = $mods_list->[0];
128 my $cmethod = $self->method_lookup(
129 "open-ils.search.biblio.record.copy_count");
130 my ($count) = $cmethod->run($org_id, $id);
131 $mods_obj->copy_count($count);
137 __PACKAGE__->register_method(
138 method => "record_id_to_mods_slim",
139 api_name => "open-ils.search.biblio.record.mods_slim.retrieve",
141 note => "Provide ID, we provide the mods"
144 # converts a record into a mods object with NO copy counts attached
145 sub record_id_to_mods_slim {
147 my( $self, $client, $id ) = @_;
148 warn "Retrieving MODS object for record $id\n";
149 return undef unless(defined $id);
151 my $mods_list = _records_to_mods( $id );
152 my $mods_obj = $mods_list->[0];
157 # Returns the number of copies attached to a record based on org location
158 __PACKAGE__->register_method(
159 method => "record_id_to_copy_count",
160 api_name => "open-ils.search.biblio.record.copy_count",
163 __PACKAGE__->register_method(
164 method => "record_id_to_copy_count",
165 api_name => "open-ils.search.biblio.metarecord.copy_count",
167 sub record_id_to_copy_count {
168 my( $self, $client, $org_id, $record_id ) = @_;
170 my $method = "open-ils.storage.biblio.record_entry.copy_count.atomic";
172 if($self->api_name =~ /metarecord/) {
173 $method = "open-ils.storage.metabib.metarecord.copy_count.atomic";
177 my $session = OpenSRF::AppSession->create("open-ils.storage");
178 warn "copy_count retrieve $record_id\n";
179 return undef unless(defined $record_id);
181 my $request = $session->request(
182 $method, org_unit => $org_id => $key => $record_id );
185 my $count = $request->gather(1);
186 $session->disconnect();
187 return [ sort { $a->{depth} <=> $b->{depth} } @$count ];
192 # used for cat search classes
193 my $cat_search_hash = {
196 { tag => "100", subfield => "a"} ,
197 { tag => "700", subfield => "a"},
201 { tag => "245", subfield => "a"},
202 { tag => "242", subfield => "a"},
203 { tag => "240", subfield => "a"},
204 { tag => "210", subfield => "a"},
208 { tag => "650", subfield => "_" },
212 { tag => "035", subfield => "_" },
216 { tag => "020", subfield => "a" },
222 __PACKAGE__->register_method(
223 method => "biblio_search_tcn",
224 api_name => "open-ils.search.biblio.tcn",
226 note => "Retrieve a record by TCN",
229 sub biblio_search_tcn {
231 my( $self, $client, $tcn ) = @_;
233 $tcn =~ s/.*?(\w+)\s*$/$1/o;
234 warn "Searching TCN $tcn\n";
236 my $session = OpenSRF::AppSession->create( "open-ils.storage" );
237 my $request = $session->request(
238 "open-ils.storage.direct.biblio.record_entry.search.tcn_value", $tcn );
239 my $record_entry = $request->gather(1);
242 for my $record (@$record_entry) {
243 push @ids, $record->id;
246 $session->disconnect();
248 warn "received ID's for tcn search @ids\n";
251 return { count => $size, ids => \@ids };
256 # --------------------------------------------------------------------------------
259 __PACKAGE__->register_method(
260 method => "biblio_search_isbn",
261 api_name => "open-ils.search.biblio.isbn",
264 sub biblio_search_isbn {
265 my( $self, $client, $isbn ) = @_;
266 throw OpenSRF::EX::InvalidArg
268 ("biblio_search_isbn needs an ISBN to search")
269 unless defined $isbn;
271 warn "biblio search for ISBN $isbn\n";
272 my $method = $self->method_lookup("open-ils.search.biblio.marc");
273 my ($records) = $method->run( $cat_search_hash->{isbn}, $isbn );
275 my $size = @$records;
276 return { count => $size, ids => $records };
281 # --------------------------------------------------------------------------------
283 __PACKAGE__->register_method(
284 method => "biblio_barcode_to_copy",
285 api_name => "open-ils.search.asset.copy.find_by_barcode",
288 # turns a barcode into a copy object
289 sub biblio_barcode_to_copy {
290 my( $self, $client, $barcode ) = @_;
292 throw OpenSRF::EX::InvalidArg
293 ("search.biblio.barcode needs a barcode to search")
294 unless defined $barcode;
296 warn "copy search for barcode $barcode\n";
297 my $record = OpenILS::Application::AppUtils->simple_scalar_request(
299 "open-ils.storage.direct.asset.copy.search.barcode",
302 return undef unless($record);
307 __PACKAGE__->register_method(
308 method => "biblio_id_to_copy",
309 api_name => "open-ils.search.asset.copy.batch.retrieve",
312 # turns a barcode into a copy object
313 sub biblio_id_to_copy {
314 my( $self, $client, $ids ) = @_;
316 throw OpenSRF::EX::InvalidArg
317 ("search.biblio.batch.retrieve needs a id to search")
320 warn "copy search for ids @$ids\n";
321 my $record = OpenILS::Application::AppUtils->simple_scalar_request(
323 "open-ils.storage.direct.asset.copy.batch.retrieve.atomic",
331 __PACKAGE__->register_method(
332 method => "fleshed_copy_retrieve",
333 api_name => "open-ils.search.asset.copy.fleshed.batch.retrieve",
336 # turns a barcode into a copy object
337 sub fleshed_copy_retrieve {
338 my( $self, $client, $ids ) = @_;
340 throw OpenSRF::EX::InvalidArg
341 ("search.biblio.batch.retrieve needs a id to search")
344 warn "fleshed copy search for id @$ids\n";
345 my $copy = OpenILS::Application::AppUtils->simple_scalar_request(
347 "open-ils.storage.fleshed.asset.copy.batch.retrieve.atomic",
355 __PACKAGE__->register_method(
356 method => "biblio_barcode_to_title",
357 api_name => "open-ils.search.biblio.find_by_barcode",
360 sub biblio_barcode_to_title {
361 my( $self, $client, $barcode ) = @_;
364 throw OpenSRF::EX::ERROR
365 ("Not enough args to find_by_barcode");
368 my $title = $apputils->simple_scalar_request(
370 "open-ils.storage.biblio.record_entry.retrieve_by_barcode",
373 return { ids => $title->id, count => 1 };
376 my $u = OpenILS::Utils::ModsParser->new();
377 $u->start_mods_batch( $title->marc );
378 my $mods = $u->finish_mods_batch();
379 $mods->doc_id($title->id());
386 __PACKAGE__->register_method(
387 method => "biblio_copy_to_mods",
388 api_name => "open-ils.search.biblio.copy.mods.retrieve",
391 # takes a copy object and returns it fleshed mods object
392 sub biblio_copy_to_mods {
393 my( $self, $client, $copy ) = @_;
395 throw OpenSRF::EX::InvalidArgs
396 ("copy.mods.retrieve needs a copy") unless( $copy );
398 new Fieldmapper::asset::copy($copy);
400 my $volume = OpenILS::Application::AppUtils->simple_scalar_request(
402 "open-ils.storage.direct.asset.call_number.retrieve",
403 $copy->call_number() );
405 my $mods = _records_to_mods($volume->record());
406 $mods = shift @$mods;
407 $volume->copies([$copy]);
408 push @{$mods->call_numbers()}, $volume;
414 sub barcode_to_mods {
419 # --------------------------------------------------------------------------------
423 __PACKAGE__->register_method(
424 method => "cat_biblio_search_class",
425 api_name => "open-ils.search.cat.biblio.class",
429 sub cat_biblio_search_class {
431 my( $self, $client, $org_id, $class, $sort, $string ) = @_;
433 throw OpenSRF::EX::InvalidArg
434 ("Not enough args to open-ils.search.cat.biblio.class")
435 unless( defined($org_id) and $class and $sort and $string );
440 my $method = $self->method_lookup("open-ils.search.biblio.marc");
442 throw OpenSRF::EX::PANIC
443 ("Can't lookup method 'open-ils.search.biblio.marc'");
446 my ($records) = $method->run( $cat_search_hash->{$class}, $string );
449 for my $i (@$records) { push @ids, $i->[0]; }
451 my $mods_list = _records_to_mods( @ids );
452 return undef unless (ref($mods_list) eq "ARRAY");
454 # ---------------------------------------------------------------
455 # append copy count information to the mods objects
456 my $session = OpenSRF::AppSession->create("open-ils.storage");
458 my $request = $session->request(
459 "open-ils.storage.direct.biblio.record_copy_count.batch", $org_id, @ids );
463 warn "receiving copy counts for doc $id\n";
465 my $response = $request->recv();
466 next unless $response;
468 if( $response and UNIVERSAL::isa($response, "Error")) {
469 throw $response ($response->stringify);
472 my $count = $response->content;
473 my $mods_obj = undef;
474 for my $m (@$mods_list) {
475 $mods_obj = $m if ($m->doc_id() == $id)
478 $mods_obj->copy_count($count);
481 $client->respond( $mods_obj );
487 $session->disconnect();
489 # ---------------------------------------------------------------
496 __PACKAGE__->register_method(
497 method => "cat_biblio_search_class_id",
498 api_name => "open-ils.search.cat.biblio.class.id",
500 note => "Searches biblio information by search class and returns the IDs",
503 sub cat_biblio_search_class_id {
505 my( $self, $client, $org_id, $class, $string, $limit, $offset ) = @_;
512 my $bool = ($class eq "subject" || $class eq "keyword");
513 $string = OpenILS::Application::Search->filter_search($string, $bool);
516 return OpenILS::EX->new("SEARCH_TOO_LARGE")->ex();
519 warn "Searching cat.biblio.class.id string: $string offset: $offset limit: $limit\n";
521 throw OpenSRF::EX::InvalidArg
522 ("Not enough args to open-ils.search.cat.biblio.class")
523 unless( defined($org_id) and $class and $string );
528 my $cache_key = md5_hex( $org_id . $class . $string );
529 my $id_array = OpenILS::Application::SearchCache->get_cache($cache_key);
532 warn "Returning class search from cache\n";
533 my $size = @$id_array;
534 my @ids = @$id_array[ $offset..($offset+$limit) ];
535 return { count => $size, ids => \@ids };
538 my $method = $self->method_lookup("open-ils.search.biblio.marc");
540 throw OpenSRF::EX::PANIC
541 ("Can't lookup method 'open-ils.search.biblio.marc'");
544 my ($records) = $method->run( $cat_search_hash->{$class}, $string );
548 for my $i (@$records) {
549 if(defined($i->[0])) {
550 push @cache_ids, $i->[0];
554 my @ids = @cache_ids[ $offset..($offset+$limit) ];
555 my $size = @$records;
557 OpenILS::Application::SearchCache->put_cache(
558 $cache_key, \@cache_ids, $size );
560 return { count =>$size, ids => \@ids };
564 __PACKAGE__->register_method(
565 method => "biblio_search_class_count",
566 api_name => "open-ils.search.biblio.class.count",
568 note => "Searches biblio information by search class and returns the IDs",
570 sub biblio_search_class_count {
572 my( $self, $client, $class, $string, $org_id, $org_type ) = @_;
574 warn "org: $org_id : depth: $org_type\n";
576 $org_id = "1" unless defined($org_id); # xxx
577 $org_type = 0 unless defined($org_type);
579 warn "Searching biblio.class.id\n" .
581 "org_id: $org_id\n" .
582 "depth: $org_type\n" ;
584 my $bool = ($class eq "subject" || $class eq "keyword");
585 $string = OpenILS::Application::Search->filter_search($string, $bool);
588 return OpenILS::EX->new("SEARCH_TOO_LARGE")->ex;
592 if( !defined($org_id) or !$class or !$string ) {
593 warn "not enbough args to metarecord search\n";
594 throw OpenSRF::EX::InvalidArg
595 ("Not enough args to open-ils.search.cat.biblio.class")
600 if( ($class ne "title") and ($class ne "author") and
601 ($class ne "subject") and ($class ne "keyword") ) {
602 warn "Invalid search class: $class\n";
603 throw OpenSRF::EX::InvalidArg ("Not a valid search class: $class")
606 # grab the mr id's from storage
608 my $method = "open-ils.storage.metabib.$class.search_fts.metarecord_count";
609 warn "Performing count method $method\n";
610 my $session = OpenSRF::AppSession->create('open-ils.storage');
612 my $request = $session->request( $method,
617 my $count = $request->gather(1);
618 warn "Received count $count\n";
624 __PACKAGE__->register_method(
625 method => "biblio_search_class",
626 api_name => "open-ils.search.biblio.class",
629 __PACKAGE__->register_method(
630 method => "biblio_search_class",
631 api_name => "open-ils.search.biblio.class.unordered",
634 sub biblio_search_class {
636 my( $self, $client, $class, $string,
637 $org_id, $org_type, $limit, $offset ) = @_;
639 warn "org: $org_id : depth: $org_type : limit: $limit : offset: $offset\n";
642 $limit = 100 unless defined($limit and $limit > 0 );
643 $org_id = "1" unless defined($org_id); # xxx
644 $org_type = 0 unless defined($org_type);
646 warn "Searching biblio.class.id\n" .
648 "\noffset: $offset\n" .
650 "org_id: $org_id\n" .
651 "depth: $org_type\n" ;
653 warn "Search filtering string " . time() . "\n";
654 $string = OpenILS::Application::Search->filter_search($string);
655 if(!$string) { return undef; }
657 if( !defined($org_id) or !$class or !$string ) {
658 warn "not enbough args to metarecord search\n";
659 throw OpenSRF::EX::InvalidArg
660 ("Not enough args to open-ils.search.cat.biblio.class")
665 if( ($class ne "title") and ($class ne "author") and
666 ($class ne "subject") and ($class ne "keyword") ) {
667 warn "Invalid search class: $class\n";
668 throw OpenSRF::EX::InvalidArg ("Not a valid search class: $class")
671 my $method = "open-ils.storage.metabib.$class.search_fts.metarecord.atomic";
673 if($self->api_name =~ /order/) {
674 $method = "open-ils.storage.metabib.$class.search_fts.metarecord.unordered.atomic";
677 warn "MR search method is $method\n";
679 my $session = OpenSRF::AppSession->create('open-ils.storage');
681 warn "Search making request " . time() . "\n";
682 my $request = $session->request(
683 #"open-ils.storage.cachable.metabib.$class.search_fts.metarecord.atomic",
692 my $records = $request->gather(1);
693 warn "Search request complete " . time() . "\n";
698 warn "Received " . scalar(@$records) . " id's from class search\n";
700 # if we just get one, it won't be wrapped in an array
701 if(!ref($records->[0])) {
702 $records = [$records]; }
703 for my $i (@$records) {
710 @ids = grep { defined($_->[0]) } @ids;
713 $session->disconnect();
715 return { ids => \@ids };
722 __PACKAGE__->register_method(
723 method => "biblio_mrid_to_modsbatch",
724 api_name => "open-ils.search.biblio.metarecord.mods_slim.retrieve",
727 sub biblio_mrid_to_modsbatch {
728 my( $self, $client, $mrid ) = @_;
730 throw OpenSRF::EX::InvalidArg
731 ("search.biblio.metarecord_to_mods requires mr id")
732 unless defined( $mrid );
735 my $metarecord = OpenILS::Application::AppUtils->simple_scalar_request( "open-ils.storage",
736 "open-ils.storage.direct.metabib.metarecord.retrieve", $mrid );
739 throw OpenSRF::EX::ERROR ("No metarecord exists with the given id: $mrid");
742 my $master_id = $metarecord->master_record();
745 # check for existing mods
746 if($metarecord->mods()){
747 warn "We already have mods for " . $metarecord->id . "\n";
748 my $perl = JSON->JSON2perl($metarecord->mods());
749 return Fieldmapper::metabib::virtual_record->new($perl);
754 warn "Creating mods batch for metarecord $mrid\n";
755 my $id_hash = biblio_mrid_to_record_ids( undef, undef, $mrid );
756 my @ids = @{$id_hash->{ids}};
758 if(@ids < 1) { return undef; }
760 warn "Master ID is $master_id\n";
761 # grab the master record to start the mods batch
763 my $record = OpenILS::Application::AppUtils->simple_scalar_request( "open-ils.storage",
764 "open-ils.storage.direct.biblio.record_entry.retrieve", $master_id );
767 throw OpenSRF::EX::ERROR
768 ("No record returned with id $master_id");
771 my $u = OpenILS::Utils::ModsParser->new();
773 $u->start_mods_batch( $record->marc );
774 my $main_doc_id = $record->id();
776 @ids = grep { $_ ne $master_id } @ids;
778 # now we have to collect all of the marc objects and push them into a mods batch
779 my $session = OpenSRF::AppSession->create("open-ils.storage");
780 my $request = $session->request(
781 "open-ils.storage.direct.biblio.record_entry.batch.retrieve", @ids );
783 while( my $response = $request->recv() ) {
785 next unless $response;
786 if(UNIVERSAL::isa( $response,"OpenSRF::EX")) {
787 throw $response ($response->stringify);
790 my $content = $response->content;
793 $u->push_mods_batch( $content->marc );
797 my $mods = $u->finish_mods_batch();
798 $mods->doc_id($mrid);
801 $client->respond_complete($mods);
803 my $mods_string = JSON->perl2JSON($mods->decast);
805 $metarecord->mods($mods_string);
807 my $req = $session->request(
808 "open-ils.storage.direct.metabib.metarecord.update",
815 $session->disconnect();
823 # converts a mr id into a list of record ids
825 __PACKAGE__->register_method(
826 method => "biblio_mrid_to_record_ids",
827 api_name => "open-ils.search.biblio.metarecord_to_records",
830 sub biblio_mrid_to_record_ids {
831 my( $self, $client, $mrid ) = @_;
833 throw OpenSRF::EX::InvalidArg
834 ("search.biblio.metarecord_to_record_ids requires mr id")
835 unless defined( $mrid );
837 warn "Searching for record for MR $mrid\n";
839 my $mrmaps = OpenILS::Application::AppUtils->simple_scalar_request( "open-ils.storage",
840 "open-ils.storage.direct.metabib.metarecord_source_map.search.metarecord", $mrid );
843 for my $map (@$mrmaps) { push @ids, $map->source(); }
845 warn "Recovered id's [@ids] for mr $mrid\n";
849 return { count => $size, ids => \@ids };
855 __PACKAGE__->register_method(
856 method => "biblio_record_to_marc_html",
857 api_name => "open-ils.search.biblio.record.html" );
859 my $parser = XML::LibXML->new();
860 my $xslt = XML::LibXSLT->new();
863 my $settings_client = OpenSRF::Utils::SettingsClient->new();
864 sub biblio_record_to_marc_html {
865 my( $self, $client, $recordid ) = @_;
868 my $dir = $settings_client->config_value( "dirs", "xsl" );
869 my $xsl = $settings_client->config_value(
870 "apps", "open-ils.search", "app_settings", "marc_html_xsl" );
872 $xsl = $parser->parse_file("$dir/$xsl");
873 $marc_sheet = $xslt->parse_stylesheet( $xsl );
877 my $record = $apputils->simple_scalar_request(
879 "open-ils.storage.direct.biblio.record_entry.retrieve",
882 my $xmldoc = $parser->parse_string($record->marc);
883 my $html = $marc_sheet->transform($xmldoc);
884 $html = $html->toString();
891 __PACKAGE__->register_method(
892 method => "retrieve_all_copy_locations",
893 api_name => "open-ils.search.config.copy_location.retrieve.all" );
895 my $shelving_locations;
896 sub retrieve_all_copy_locations {
897 my( $self, $client ) = @_;
898 if(!$shelving_locations) {
899 $shelving_locations = $apputils->simple_scalar_request(
901 "open-ils.storage.direct.asset.copy_location.retrieve.all.atomic");
903 return $shelving_locations;
908 __PACKAGE__->register_method(
909 method => "retrieve_all_copy_statuses",
910 api_name => "open-ils.search.config.copy_status.retrieve.all" );
913 sub retrieve_all_copy_statuses {
914 my( $self, $client ) = @_;
915 if(!$copy_statuses) {
916 $copy_statuses = $apputils->simple_scalar_request(
918 "open-ils.storage.direct.config.copy_status.retrieve.all.atomic" );
920 return $copy_statuses;