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",
168 __PACKAGE__->register_method(
169 method => "record_id_to_copy_count",
170 api_name => "open-ils.search.biblio.metarecord.copy_count.staff",
172 sub record_id_to_copy_count {
173 my( $self, $client, $org_id, $record_id ) = @_;
175 my $method = "open-ils.storage.biblio.record_entry.copy_count.atomic";
177 if($self->api_name =~ /metarecord/) {
178 $method = "open-ils.storage.metabib.metarecord.copy_count.atomic";
182 if($self->api_name =~ /staff/ ) {
183 $method =~ s/atomic/staff\.atomic/og;
184 warn "Doing staff search $method\n";
188 my $session = OpenSRF::AppSession->create("open-ils.storage");
189 warn "copy_count retrieve $record_id\n";
190 return undef unless(defined $record_id);
192 my $request = $session->request(
193 $method, org_unit => $org_id => $key => $record_id );
196 my $count = $request->gather(1);
197 $session->disconnect();
198 return [ sort { $a->{depth} <=> $b->{depth} } @$count ];
203 # used for cat search classes
204 my $cat_search_hash = {
207 { tag => "100", subfield => "a"} ,
208 { tag => "700", subfield => "a"},
212 { tag => "245", subfield => "a"},
213 { tag => "242", subfield => "a"},
214 { tag => "240", subfield => "a"},
215 { tag => "210", subfield => "a"},
219 { tag => "650", subfield => "_" },
223 { tag => "035", subfield => "_" },
227 { tag => "020", subfield => "a" },
233 __PACKAGE__->register_method(
234 method => "biblio_search_tcn",
235 api_name => "open-ils.search.biblio.tcn",
237 note => "Retrieve a record by TCN",
240 sub biblio_search_tcn {
242 my( $self, $client, $tcn ) = @_;
244 $tcn =~ s/.*?(\w+)\s*$/$1/o;
245 warn "Searching TCN $tcn\n";
247 my $session = OpenSRF::AppSession->create( "open-ils.storage" );
248 my $request = $session->request(
249 "open-ils.storage.direct.biblio.record_entry.search.tcn_value", $tcn );
250 my $record_entry = $request->gather(1);
253 for my $record (@$record_entry) {
254 push @ids, $record->id;
257 $session->disconnect();
259 warn "received ID's for tcn search @ids\n";
262 return { count => $size, ids => \@ids };
267 # --------------------------------------------------------------------------------
270 __PACKAGE__->register_method(
271 method => "biblio_search_isbn",
272 api_name => "open-ils.search.biblio.isbn",
275 sub biblio_search_isbn {
276 my( $self, $client, $isbn ) = @_;
277 throw OpenSRF::EX::InvalidArg
279 ("biblio_search_isbn needs an ISBN to search")
280 unless defined $isbn;
282 warn "biblio search for ISBN $isbn\n";
283 my $method = $self->method_lookup("open-ils.search.biblio.marc");
284 my ($records) = $method->run( $cat_search_hash->{isbn}, $isbn );
286 my $size = @$records;
287 return { count => $size, ids => $records };
292 # --------------------------------------------------------------------------------
294 __PACKAGE__->register_method(
295 method => "biblio_barcode_to_copy",
296 api_name => "open-ils.search.asset.copy.find_by_barcode",
299 # turns a barcode into a copy object
300 sub biblio_barcode_to_copy {
301 my( $self, $client, $barcode ) = @_;
303 throw OpenSRF::EX::InvalidArg
304 ("search.biblio.barcode needs a barcode to search")
305 unless defined $barcode;
307 warn "copy search for barcode $barcode\n";
308 my $record = OpenILS::Application::AppUtils->simple_scalar_request(
310 "open-ils.storage.direct.asset.copy.search.barcode",
313 return undef unless($record);
318 __PACKAGE__->register_method(
319 method => "biblio_id_to_copy",
320 api_name => "open-ils.search.asset.copy.batch.retrieve",
323 # turns a barcode into a copy object
324 sub biblio_id_to_copy {
325 my( $self, $client, $ids ) = @_;
327 throw OpenSRF::EX::InvalidArg
328 ("search.biblio.batch.retrieve needs a id to search")
331 warn "copy search for ids @$ids\n";
332 my $record = OpenILS::Application::AppUtils->simple_scalar_request(
334 "open-ils.storage.direct.asset.copy.batch.retrieve.atomic",
342 __PACKAGE__->register_method(
343 method => "fleshed_copy_retrieve",
344 api_name => "open-ils.search.asset.copy.fleshed.batch.retrieve",
347 # turns a barcode into a copy object
348 sub fleshed_copy_retrieve {
349 my( $self, $client, $ids ) = @_;
351 throw OpenSRF::EX::InvalidArg
352 ("search.biblio.batch.retrieve needs a id to search")
355 warn "fleshed copy search for id @$ids\n";
356 my $copy = OpenILS::Application::AppUtils->simple_scalar_request(
358 "open-ils.storage.fleshed.asset.copy.batch.retrieve.atomic",
366 __PACKAGE__->register_method(
367 method => "biblio_barcode_to_title",
368 api_name => "open-ils.search.biblio.find_by_barcode",
371 sub biblio_barcode_to_title {
372 my( $self, $client, $barcode ) = @_;
375 throw OpenSRF::EX::ERROR
376 ("Not enough args to find_by_barcode");
379 my $title = $apputils->simple_scalar_request(
381 "open-ils.storage.biblio.record_entry.retrieve_by_barcode",
384 return { ids => $title->id, count => 1 };
387 my $u = OpenILS::Utils::ModsParser->new();
388 $u->start_mods_batch( $title->marc );
389 my $mods = $u->finish_mods_batch();
390 $mods->doc_id($title->id());
397 __PACKAGE__->register_method(
398 method => "biblio_copy_to_mods",
399 api_name => "open-ils.search.biblio.copy.mods.retrieve",
402 # takes a copy object and returns it fleshed mods object
403 sub biblio_copy_to_mods {
404 my( $self, $client, $copy ) = @_;
406 throw OpenSRF::EX::InvalidArgs
407 ("copy.mods.retrieve needs a copy") unless( $copy );
409 new Fieldmapper::asset::copy($copy);
411 my $volume = OpenILS::Application::AppUtils->simple_scalar_request(
413 "open-ils.storage.direct.asset.call_number.retrieve",
414 $copy->call_number() );
416 my $mods = _records_to_mods($volume->record());
417 $mods = shift @$mods;
418 $volume->copies([$copy]);
419 push @{$mods->call_numbers()}, $volume;
425 sub barcode_to_mods {
430 # --------------------------------------------------------------------------------
434 __PACKAGE__->register_method(
435 method => "cat_biblio_search_class",
436 api_name => "open-ils.search.cat.biblio.class",
440 sub cat_biblio_search_class {
442 my( $self, $client, $org_id, $class, $sort, $string ) = @_;
444 throw OpenSRF::EX::InvalidArg
445 ("Not enough args to open-ils.search.cat.biblio.class")
446 unless( defined($org_id) and $class and $sort and $string );
451 my $method = $self->method_lookup("open-ils.search.biblio.marc");
453 throw OpenSRF::EX::PANIC
454 ("Can't lookup method 'open-ils.search.biblio.marc'");
457 my ($records) = $method->run( $cat_search_hash->{$class}, $string );
460 for my $i (@$records) { push @ids, $i->[0]; }
462 my $mods_list = _records_to_mods( @ids );
463 return undef unless (ref($mods_list) eq "ARRAY");
465 # ---------------------------------------------------------------
466 # append copy count information to the mods objects
467 my $session = OpenSRF::AppSession->create("open-ils.storage");
469 my $request = $session->request(
470 "open-ils.storage.direct.biblio.record_copy_count.batch", $org_id, @ids );
474 warn "receiving copy counts for doc $id\n";
476 my $response = $request->recv();
477 next unless $response;
479 if( $response and UNIVERSAL::isa($response, "Error")) {
480 throw $response ($response->stringify);
483 my $count = $response->content;
484 my $mods_obj = undef;
485 for my $m (@$mods_list) {
486 $mods_obj = $m if ($m->doc_id() == $id)
489 $mods_obj->copy_count($count);
492 $client->respond( $mods_obj );
498 $session->disconnect();
500 # ---------------------------------------------------------------
507 __PACKAGE__->register_method(
508 method => "cat_biblio_search_class_id",
509 api_name => "open-ils.search.cat.biblio.class.id",
511 note => "Searches biblio information by search class and returns the IDs",
514 sub cat_biblio_search_class_id {
516 my( $self, $client, $org_id, $class, $string, $limit, $offset ) = @_;
523 my $bool = ($class eq "subject" || $class eq "keyword");
524 $string = OpenILS::Application::Search->filter_search($string, $bool);
527 return OpenILS::EX->new("SEARCH_TOO_LARGE")->ex();
530 warn "Searching cat.biblio.class.id string: $string offset: $offset limit: $limit\n";
532 throw OpenSRF::EX::InvalidArg
533 ("Not enough args to open-ils.search.cat.biblio.class")
534 unless( defined($org_id) and $class and $string );
539 my $cache_key = md5_hex( $org_id . $class . $string );
540 my $id_array = OpenILS::Application::SearchCache->get_cache($cache_key);
543 warn "Returning class search from cache\n";
544 my $size = @$id_array;
545 my @ids = @$id_array[ $offset..($offset+$limit) ];
546 return { count => $size, ids => \@ids };
549 my $method = $self->method_lookup("open-ils.search.biblio.marc");
551 throw OpenSRF::EX::PANIC
552 ("Can't lookup method 'open-ils.search.biblio.marc'");
555 my ($records) = $method->run( $cat_search_hash->{$class}, $string );
559 for my $i (@$records) {
560 if(defined($i->[0])) {
561 push @cache_ids, $i->[0];
565 my @ids = @cache_ids[ $offset..($offset+$limit) ];
566 my $size = @$records;
568 OpenILS::Application::SearchCache->put_cache(
569 $cache_key, \@cache_ids, $size );
571 return { count =>$size, ids => \@ids };
575 __PACKAGE__->register_method(
576 method => "biblio_search_class_count",
577 api_name => "open-ils.search.biblio.class.count",
580 __PACKAGE__->register_method(
581 method => "biblio_search_class_count",
582 api_name => "open-ils.search.biblio.class.count.staff",
585 sub biblio_search_class_count {
587 my( $self, $client, $class, $string, $org_id, $org_type ) = @_;
589 warn "org: $org_id : depth: $org_type\n";
591 $org_id = "1" unless defined($org_id); # xxx
592 $org_type = 0 unless defined($org_type);
594 warn "Searching biblio.class.id\n" .
596 "org_id: $org_id\n" .
597 "depth: $org_type\n" ;
599 my $bool = ($class eq "subject" || $class eq "keyword");
600 $string = OpenILS::Application::Search->filter_search($string, $bool);
603 return OpenILS::EX->new("SEARCH_TOO_LARGE")->ex;
607 if( !defined($org_id) or !$class or !$string ) {
608 warn "not enbough args to metarecord search\n";
609 throw OpenSRF::EX::InvalidArg
610 ("Not enough args to open-ils.search.cat.biblio.class")
615 if( ($class ne "title") and ($class ne "author") and
616 ($class ne "subject") and ($class ne "keyword")
617 and ($class ne "series" )) {
618 warn "Invalid search class: $class\n";
619 throw OpenSRF::EX::InvalidArg ("Not a valid search class: $class")
622 # grab the mr id's from storage
624 my $method = "open-ils.storage.metabib.$class.search_fts.metarecord_count";
625 if($self->api_name =~ /staff/) { $method = "$method.staff"; }
626 warn "Performing count method $method\n";
627 warn "API name " . $self->api_name() . "\n";
629 my $session = OpenSRF::AppSession->create('open-ils.storage');
631 my $request = $session->request( $method,
636 my $count = $request->gather(1);
637 warn "Received count $count\n";
643 __PACKAGE__->register_method(
644 method => "biblio_search_class",
645 api_name => "open-ils.search.biblio.class",
648 __PACKAGE__->register_method(
649 method => "biblio_search_class",
650 api_name => "open-ils.search.biblio.class.unordered",
653 __PACKAGE__->register_method(
654 method => "biblio_search_class",
655 api_name => "open-ils.search.biblio.class.staff",
658 __PACKAGE__->register_method(
659 method => "biblio_search_class",
660 api_name => "open-ils.search.biblio.class.unordered.staff",
663 sub biblio_search_class {
665 my( $self, $client, $class, $string,
666 $org_id, $org_type, $limit, $offset ) = @_;
668 warn "org: $org_id : depth: $org_type : limit: $limit : offset: $offset\n";
671 $limit = 100 unless defined($limit and $limit > 0 );
672 $org_id = "1" unless defined($org_id); # xxx
673 $org_type = 0 unless defined($org_type);
675 warn "Searching biblio.class.id\n" .
677 "\noffset: $offset\n" .
679 "org_id: $org_id\n" .
680 "depth: $org_type\n" ;
682 warn "Search filtering string " . time() . "\n";
683 $string = OpenILS::Application::Search->filter_search($string);
684 if(!$string) { return undef; }
686 if( !defined($org_id) or !$class or !$string ) {
687 warn "not enbough args to metarecord search\n";
688 throw OpenSRF::EX::InvalidArg
689 ("Not enough args to open-ils.search.cat.biblio.class")
694 if( ($class ne "title") and ($class ne "author") and
695 ($class ne "subject") and ($class ne "keyword")
696 and ($class ne "series") ) {
697 warn "Invalid search class: $class\n";
698 throw OpenSRF::EX::InvalidArg ("Not a valid search class: $class")
701 my $method = "open-ils.storage.metabib.$class.search_fts.metarecord.atomic";
703 if($self->api_name =~ /order/) {
704 $method = "open-ils.storage.metabib.$class.search_fts.metarecord.unordered.atomic";
707 if($self->api_name =~ /staff/) {
708 $method =~ s/atomic/staff\.atomic/og;
711 warn "Performing search method $method\n";
712 warn "MR search method is $method\n";
714 my $session = OpenSRF::AppSession->create('open-ils.storage');
716 warn "Search making request " . time() . "\n";
717 my $request = $session->request(
718 #"open-ils.storage.cachable.metabib.$class.search_fts.metarecord.atomic",
727 my $records = $request->gather(1);
728 warn "Search request complete " . time() . "\n";
733 warn "Received " . scalar(@$records) . " id's from class search\n";
735 # if we just get one, it won't be wrapped in an array
736 if(!ref($records->[0])) {
737 $records = [$records]; }
738 for my $i (@$records) {
745 @ids = grep { defined($_->[0]) } @ids;
748 $session->disconnect();
750 return { ids => \@ids };
757 __PACKAGE__->register_method(
758 method => "biblio_mrid_to_modsbatch",
759 api_name => "open-ils.search.biblio.metarecord.mods_slim.retrieve",
762 sub biblio_mrid_to_modsbatch {
763 my( $self, $client, $mrid ) = @_;
765 throw OpenSRF::EX::InvalidArg
766 ("search.biblio.metarecord_to_mods requires mr id")
767 unless defined( $mrid );
770 my $metarecord = OpenILS::Application::AppUtils->simple_scalar_request( "open-ils.storage",
771 "open-ils.storage.direct.metabib.metarecord.retrieve", $mrid );
774 throw OpenSRF::EX::ERROR ("No metarecord exists with the given id: $mrid");
777 my $master_id = $metarecord->master_record();
780 # check for existing mods
781 if($metarecord->mods()){
782 warn "We already have mods for " . $metarecord->id . "\n";
783 my $perl = JSON->JSON2perl($metarecord->mods());
784 return Fieldmapper::metabib::virtual_record->new($perl);
789 warn "Creating mods batch for metarecord $mrid\n";
790 my $id_hash = biblio_mrid_to_record_ids( undef, undef, $mrid );
791 my @ids = @{$id_hash->{ids}};
793 if(@ids < 1) { return undef; }
795 warn "Master ID is $master_id\n";
796 # grab the master record to start the mods batch
798 my $record = OpenILS::Application::AppUtils->simple_scalar_request( "open-ils.storage",
799 "open-ils.storage.direct.biblio.record_entry.retrieve", $master_id );
802 throw OpenSRF::EX::ERROR
803 ("No record returned with id $master_id");
806 my $u = OpenILS::Utils::ModsParser->new();
808 $u->start_mods_batch( $record->marc );
809 my $main_doc_id = $record->id();
811 @ids = grep { $_ ne $master_id } @ids;
813 # now we have to collect all of the marc objects and push them into a mods batch
814 my $session = OpenSRF::AppSession->create("open-ils.storage");
815 my $request = $session->request(
816 "open-ils.storage.direct.biblio.record_entry.batch.retrieve", @ids );
818 while( my $response = $request->recv() ) {
820 next unless $response;
821 if(UNIVERSAL::isa( $response,"OpenSRF::EX")) {
822 throw $response ($response->stringify);
825 my $content = $response->content;
828 $u->push_mods_batch( $content->marc );
832 my $mods = $u->finish_mods_batch();
833 $mods->doc_id($mrid);
836 $client->respond_complete($mods);
838 my $mods_string = JSON->perl2JSON($mods->decast);
840 $metarecord->mods($mods_string);
842 my $req = $session->request(
843 "open-ils.storage.direct.metabib.metarecord.update",
850 $session->disconnect();
858 # converts a mr id into a list of record ids
860 __PACKAGE__->register_method(
861 method => "biblio_mrid_to_record_ids",
862 api_name => "open-ils.search.biblio.metarecord_to_records",
865 sub biblio_mrid_to_record_ids {
866 my( $self, $client, $mrid ) = @_;
868 throw OpenSRF::EX::InvalidArg
869 ("search.biblio.metarecord_to_record_ids requires mr id")
870 unless defined( $mrid );
872 warn "Searching for record for MR $mrid\n";
874 my $mrmaps = OpenILS::Application::AppUtils->simple_scalar_request( "open-ils.storage",
875 "open-ils.storage.direct.metabib.metarecord_source_map.search.metarecord", $mrid );
878 for my $map (@$mrmaps) { push @ids, $map->source(); }
880 warn "Recovered id's [@ids] for mr $mrid\n";
884 return { count => $size, ids => \@ids };
890 __PACKAGE__->register_method(
891 method => "biblio_record_to_marc_html",
892 api_name => "open-ils.search.biblio.record.html" );
894 my $parser = XML::LibXML->new();
895 my $xslt = XML::LibXSLT->new();
898 my $settings_client = OpenSRF::Utils::SettingsClient->new();
899 sub biblio_record_to_marc_html {
900 my( $self, $client, $recordid ) = @_;
903 my $dir = $settings_client->config_value( "dirs", "xsl" );
904 my $xsl = $settings_client->config_value(
905 "apps", "open-ils.search", "app_settings", "marc_html_xsl" );
907 $xsl = $parser->parse_file("$dir/$xsl");
908 $marc_sheet = $xslt->parse_stylesheet( $xsl );
912 my $record = $apputils->simple_scalar_request(
914 "open-ils.storage.direct.biblio.record_entry.retrieve",
917 my $xmldoc = $parser->parse_string($record->marc);
918 my $html = $marc_sheet->transform($xmldoc);
919 $html = $html->toString();
926 __PACKAGE__->register_method(
927 method => "retrieve_all_copy_locations",
928 api_name => "open-ils.search.config.copy_location.retrieve.all" );
930 my $shelving_locations;
931 sub retrieve_all_copy_locations {
932 my( $self, $client ) = @_;
933 if(!$shelving_locations) {
934 $shelving_locations = $apputils->simple_scalar_request(
936 "open-ils.storage.direct.asset.copy_location.retrieve.all.atomic");
938 return $shelving_locations;
943 __PACKAGE__->register_method(
944 method => "retrieve_all_copy_statuses",
945 api_name => "open-ils.search.config.copy_status.retrieve.all" );
948 sub retrieve_all_copy_statuses {
949 my( $self, $client ) = @_;
950 if(!$copy_statuses) {
951 $copy_statuses = $apputils->simple_scalar_request(
953 "open-ils.storage.direct.config.copy_status.retrieve.all.atomic" );
955 return $copy_statuses;