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",
385 return { ids => $title->id, count => 1 };
387 return { count => 0 };
392 my $u = OpenILS::Utils::ModsParser->new();
393 $u->start_mods_batch( $title->marc );
394 my $mods = $u->finish_mods_batch();
395 $mods->doc_id($title->id());
403 __PACKAGE__->register_method(
404 method => "biblio_copy_to_mods",
405 api_name => "open-ils.search.biblio.copy.mods.retrieve",
408 # takes a copy object and returns it fleshed mods object
409 sub biblio_copy_to_mods {
410 my( $self, $client, $copy ) = @_;
412 throw OpenSRF::EX::InvalidArgs
413 ("copy.mods.retrieve needs a copy") unless( $copy );
415 new Fieldmapper::asset::copy($copy);
417 my $volume = OpenILS::Application::AppUtils->simple_scalar_request(
419 "open-ils.storage.direct.asset.call_number.retrieve",
420 $copy->call_number() );
422 my $mods = _records_to_mods($volume->record());
423 $mods = shift @$mods;
424 $volume->copies([$copy]);
425 push @{$mods->call_numbers()}, $volume;
431 sub barcode_to_mods {
436 # --------------------------------------------------------------------------------
440 __PACKAGE__->register_method(
441 method => "cat_biblio_search_class",
442 api_name => "open-ils.search.cat.biblio.class",
446 sub cat_biblio_search_class {
448 my( $self, $client, $org_id, $class, $sort, $string ) = @_;
450 throw OpenSRF::EX::InvalidArg
451 ("Not enough args to open-ils.search.cat.biblio.class")
452 unless( defined($org_id) and $class and $sort and $string );
457 my $method = $self->method_lookup("open-ils.search.biblio.marc");
459 throw OpenSRF::EX::PANIC
460 ("Can't lookup method 'open-ils.search.biblio.marc'");
463 my ($records) = $method->run( $cat_search_hash->{$class}, $string );
466 for my $i (@$records) { push @ids, $i->[0]; }
468 my $mods_list = _records_to_mods( @ids );
469 return undef unless (ref($mods_list) eq "ARRAY");
471 # ---------------------------------------------------------------
472 # append copy count information to the mods objects
473 my $session = OpenSRF::AppSession->create("open-ils.storage");
475 my $request = $session->request(
476 "open-ils.storage.direct.biblio.record_copy_count.batch", $org_id, @ids );
480 warn "receiving copy counts for doc $id\n";
482 my $response = $request->recv();
483 next unless $response;
485 if( $response and UNIVERSAL::isa($response, "Error")) {
486 throw $response ($response->stringify);
489 my $count = $response->content;
490 my $mods_obj = undef;
491 for my $m (@$mods_list) {
492 $mods_obj = $m if ($m->doc_id() == $id)
495 $mods_obj->copy_count($count);
498 $client->respond( $mods_obj );
504 $session->disconnect();
506 # ---------------------------------------------------------------
513 __PACKAGE__->register_method(
514 method => "cat_biblio_search_class_id",
515 api_name => "open-ils.search.cat.biblio.class.id",
517 note => "Searches biblio information by search class and returns the IDs",
520 sub cat_biblio_search_class_id {
522 my( $self, $client, $org_id, $class, $string, $limit, $offset ) = @_;
529 my $bool = ($class eq "subject" || $class eq "keyword");
530 $string = OpenILS::Application::Search->filter_search($string, $bool);
533 return OpenILS::EX->new("SEARCH_TOO_LARGE")->ex();
536 warn "Searching cat.biblio.class.id string: $string offset: $offset limit: $limit\n";
538 throw OpenSRF::EX::InvalidArg
539 ("Not enough args to open-ils.search.cat.biblio.class")
540 unless( defined($org_id) and $class and $string );
545 my $cache_key = md5_hex( $org_id . $class . $string );
546 my $id_array = OpenILS::Application::SearchCache->get_cache($cache_key);
549 warn "Returning class search from cache\n";
550 my $size = @$id_array;
551 my @ids = @$id_array[ $offset..($offset+$limit) ];
552 return { count => $size, ids => \@ids };
555 my $method = $self->method_lookup("open-ils.search.biblio.marc");
557 throw OpenSRF::EX::PANIC
558 ("Can't lookup method 'open-ils.search.biblio.marc'");
561 my ($records) = $method->run( $cat_search_hash->{$class}, $string );
565 for my $i (@$records) {
566 if(defined($i->[0])) {
567 push @cache_ids, $i->[0];
571 my @ids = @cache_ids[ $offset..($offset+$limit) ];
572 my $size = @$records;
574 OpenILS::Application::SearchCache->put_cache(
575 $cache_key, \@cache_ids, $size );
577 return { count =>$size, ids => \@ids };
581 __PACKAGE__->register_method(
582 method => "biblio_search_class_count",
583 api_name => "open-ils.search.biblio.class.count",
586 __PACKAGE__->register_method(
587 method => "biblio_search_class_count",
588 api_name => "open-ils.search.biblio.class.count.staff",
591 sub biblio_search_class_count {
593 my( $self, $client, $class, $string, $org_id, $org_type ) = @_;
595 warn "org: $org_id : depth: $org_type\n";
597 $org_id = "1" unless defined($org_id); # xxx
598 $org_type = 0 unless defined($org_type);
600 warn "Searching biblio.class.id\n" .
602 "org_id: $org_id\n" .
603 "depth: $org_type\n" ;
605 my $bool = ($class eq "subject" || $class eq "keyword");
606 $string = OpenILS::Application::Search->filter_search($string, $bool);
609 return OpenILS::EX->new("SEARCH_TOO_LARGE")->ex;
613 if( !defined($org_id) or !$class or !$string ) {
614 warn "not enbough args to metarecord search\n";
615 throw OpenSRF::EX::InvalidArg
616 ("Not enough args to open-ils.search.cat.biblio.class")
621 if( ($class ne "title") and ($class ne "author") and
622 ($class ne "subject") and ($class ne "keyword")
623 and ($class ne "series" )) {
624 warn "Invalid search class: $class\n";
625 throw OpenSRF::EX::InvalidArg ("Not a valid search class: $class")
628 # grab the mr id's from storage
630 my $method = "open-ils.storage.cachable.metabib.$class.search_fts.metarecord_count";
631 if($self->api_name =~ /staff/) {
632 $method = "$method.staff";
633 $method =~ s/\.cachable//o;
635 warn "Performing count method $method\n";
636 warn "API name " . $self->api_name() . "\n";
638 my $session = OpenSRF::AppSession->create('open-ils.storage');
640 my $request = $session->request( $method,
643 cache_page_size => 1,
646 my $count = $request->gather(1);
647 warn "Received count $count\n";
653 __PACKAGE__->register_method(
654 method => "biblio_search_class",
655 api_name => "open-ils.search.biblio.class",
658 __PACKAGE__->register_method(
659 method => "biblio_search_class",
660 api_name => "open-ils.search.biblio.class.unordered",
663 __PACKAGE__->register_method(
664 method => "biblio_search_class",
665 api_name => "open-ils.search.biblio.class.staff",
668 __PACKAGE__->register_method(
669 method => "biblio_search_class",
670 api_name => "open-ils.search.biblio.class.unordered.staff",
673 sub biblio_search_class {
675 my( $self, $client, $class, $string,
676 $org_id, $org_type, $limit, $offset ) = @_;
678 warn "org: $org_id : depth: $org_type : limit: $limit : offset: $offset\n";
681 $limit = 100 unless defined($limit and $limit > 0 );
682 $org_id = "1" unless defined($org_id); # xxx
683 $org_type = 0 unless defined($org_type);
685 warn "Searching biblio.class.id\n" .
687 "\noffset: $offset\n" .
689 "org_id: $org_id\n" .
690 "depth: $org_type\n" ;
692 warn "Search filtering string " . time() . "\n";
693 $string = OpenILS::Application::Search->filter_search($string);
694 if(!$string) { return undef; }
696 if( !defined($org_id) or !$class or !$string ) {
697 warn "not enbough args to metarecord search\n";
698 throw OpenSRF::EX::InvalidArg
699 ("Not enough args to open-ils.search.cat.biblio.class")
704 if( ($class ne "title") and ($class ne "author") and
705 ($class ne "subject") and ($class ne "keyword")
706 and ($class ne "series") ) {
707 warn "Invalid search class: $class\n";
708 throw OpenSRF::EX::InvalidArg ("Not a valid search class: $class")
711 #my $method = "open-ils.storage.metabib.$class.search_fts.metarecord.atomic";
712 my $method = "open-ils.storage.cachable.metabib.$class.search_fts.metarecord.atomic";
714 if($self->api_name =~ /order/) {
715 $method = "open-ils.storage.cachable.metabib.$class.search_fts.metarecord.unordered.atomic",
716 #$method = "open-ils.storage.metabib.$class.search_fts.metarecord.unordered.atomic";
719 if($self->api_name =~ /staff/) {
720 $method =~ s/atomic/staff\.atomic/og;
721 $method =~ s/\.cachable//o;
724 warn "Performing search method $method\n";
725 warn "MR search method is $method\n";
727 my $session = OpenSRF::AppSession->create('open-ils.storage');
729 warn "Search making request " . time() . "\n";
730 my $request = $session->request(
737 cache_page_size => 200,
740 my $records = $request->gather(1);
741 warn "Search request complete " . time() . "\n";
746 warn "Received " . scalar(@$records) . " id's from class search\n";
748 # if we just get one, it won't be wrapped in an array
749 if(!ref($records->[0])) {
750 $records = [$records]; }
751 for my $i (@$records) {
758 @ids = grep { defined($_->[0]) } @ids;
761 $session->disconnect();
763 return { ids => \@ids };
770 __PACKAGE__->register_method(
771 method => "biblio_mrid_to_modsbatch",
772 api_name => "open-ils.search.biblio.metarecord.mods_slim.retrieve",
775 sub biblio_mrid_to_modsbatch {
776 my( $self, $client, $mrid ) = @_;
778 throw OpenSRF::EX::InvalidArg
779 ("search.biblio.metarecord_to_mods requires mr id")
780 unless defined( $mrid );
783 my $metarecord = OpenILS::Application::AppUtils->simple_scalar_request( "open-ils.storage",
784 "open-ils.storage.direct.metabib.metarecord.retrieve", $mrid );
787 throw OpenSRF::EX::ERROR ("No metarecord exists with the given id: $mrid");
790 my $master_id = $metarecord->master_record();
793 # check for existing mods
794 if($metarecord->mods()){
795 warn "We already have mods for " . $metarecord->id . "\n";
796 my $perl = JSON->JSON2perl($metarecord->mods());
797 return Fieldmapper::metabib::virtual_record->new($perl);
802 warn "Creating mods batch for metarecord $mrid\n";
803 my $id_hash = biblio_mrid_to_record_ids( undef, undef, $mrid );
804 my @ids = @{$id_hash->{ids}};
806 if(@ids < 1) { return undef; }
808 warn "Master ID is $master_id\n";
809 # grab the master record to start the mods batch
811 my $record = OpenILS::Application::AppUtils->simple_scalar_request( "open-ils.storage",
812 "open-ils.storage.direct.biblio.record_entry.retrieve", $master_id );
815 throw OpenSRF::EX::ERROR
816 ("No record returned with id $master_id");
819 my $u = OpenILS::Utils::ModsParser->new();
821 $u->start_mods_batch( $record->marc );
822 my $main_doc_id = $record->id();
824 @ids = grep { $_ ne $master_id } @ids;
826 # now we have to collect all of the marc objects and push them into a mods batch
827 my $session = OpenSRF::AppSession->create("open-ils.storage");
828 my $request = $session->request(
829 "open-ils.storage.direct.biblio.record_entry.batch.retrieve", @ids );
831 while( my $response = $request->recv() ) {
833 next unless $response;
834 if(UNIVERSAL::isa( $response,"OpenSRF::EX")) {
835 throw $response ($response->stringify);
838 my $content = $response->content;
841 $u->push_mods_batch( $content->marc );
845 my $mods = $u->finish_mods_batch();
846 $mods->doc_id($mrid);
849 $client->respond_complete($mods);
851 my $mods_string = JSON->perl2JSON($mods->decast);
853 $metarecord->mods($mods_string);
855 my $req = $session->request(
856 "open-ils.storage.direct.metabib.metarecord.update",
863 $session->disconnect();
871 # converts a mr id into a list of record ids
873 __PACKAGE__->register_method(
874 method => "biblio_mrid_to_record_ids",
875 api_name => "open-ils.search.biblio.metarecord_to_records",
878 sub biblio_mrid_to_record_ids {
879 my( $self, $client, $mrid ) = @_;
881 throw OpenSRF::EX::InvalidArg
882 ("search.biblio.metarecord_to_record_ids requires mr id")
883 unless defined( $mrid );
885 warn "Searching for record for MR $mrid\n";
887 my $mrmaps = OpenILS::Application::AppUtils->simple_scalar_request( "open-ils.storage",
888 "open-ils.storage.direct.metabib.metarecord_source_map.search.metarecord", $mrid );
891 for my $map (@$mrmaps) { push @ids, $map->source(); }
893 warn "Recovered id's [@ids] for mr $mrid\n";
897 return { count => $size, ids => \@ids };
903 __PACKAGE__->register_method(
904 method => "biblio_record_to_marc_html",
905 api_name => "open-ils.search.biblio.record.html" );
907 my $parser = XML::LibXML->new();
908 my $xslt = XML::LibXSLT->new();
911 my $settings_client = OpenSRF::Utils::SettingsClient->new();
912 sub biblio_record_to_marc_html {
913 my( $self, $client, $recordid ) = @_;
916 my $dir = $settings_client->config_value( "dirs", "xsl" );
917 my $xsl = $settings_client->config_value(
918 "apps", "open-ils.search", "app_settings", "marc_html_xsl" );
920 $xsl = $parser->parse_file("$dir/$xsl");
921 $marc_sheet = $xslt->parse_stylesheet( $xsl );
925 my $record = $apputils->simple_scalar_request(
927 "open-ils.storage.direct.biblio.record_entry.retrieve",
930 my $xmldoc = $parser->parse_string($record->marc);
931 my $html = $marc_sheet->transform($xmldoc);
932 $html = $html->toString();
939 __PACKAGE__->register_method(
940 method => "retrieve_all_copy_locations",
941 api_name => "open-ils.search.config.copy_location.retrieve.all" );
943 my $shelving_locations;
944 sub retrieve_all_copy_locations {
945 my( $self, $client ) = @_;
946 if(!$shelving_locations) {
947 $shelving_locations = $apputils->simple_scalar_request(
949 "open-ils.storage.direct.asset.copy_location.retrieve.all.atomic");
951 return $shelving_locations;
956 __PACKAGE__->register_method(
957 method => "retrieve_all_copy_statuses",
958 api_name => "open-ils.search.config.copy_status.retrieve.all" );
961 sub retrieve_all_copy_statuses {
962 my( $self, $client ) = @_;
963 if(!$copy_statuses) {
964 $copy_statuses = $apputils->simple_scalar_request(
966 "open-ils.storage.direct.config.copy_status.retrieve.all.atomic" );
968 return $copy_statuses;