09ebf4fe1e802d50bfd32c16cb224bf6b592158e
[Evergreen.git] / Open-ILS / src / perlmods / OpenILS / Application / Search / Biblio.pm
1 package OpenILS::Application::Search::Biblio;
2 use base qw/OpenILS::Application/;
3 use strict; use warnings;
4
5
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;
12 use Encode;
13
14 use OpenSRF::Utils::Logger qw/:logger/;
15
16
17 use OpenSRF::Utils::JSON;
18
19 use Time::HiRes qw(time);
20 use OpenSRF::EX qw(:try);
21 use Digest::MD5 qw(md5_hex);
22
23 use XML::LibXML;
24 use XML::LibXSLT;
25
26 use Data::Dumper;
27 $Data::Dumper::Indent = 0;
28
29 use OpenILS::Const qw/:const/;
30
31 use OpenILS::Application::AppUtils;
32 my $apputils = "OpenILS::Application::AppUtils";
33 my $U = $apputils;
34
35 my $pfx = "open-ils.search_";
36
37 my $cache;
38 my $cache_timeout;
39 my $superpage_size;
40 my $max_superpages;
41
42 sub initialize {
43         $cache = OpenSRF::Utils::Cache->new('global');
44         my $sclient = OpenSRF::Utils::SettingsClient->new();
45         $cache_timeout = $sclient->config_value(
46                         "apps", "open-ils.search", "app_settings", "cache_timeout" ) || 300;
47
48         $superpage_size = $sclient->config_value(
49                         "apps", "open-ils.search", "app_settings", "superpage_size" ) || 500;
50
51         $max_superpages = $sclient->config_value(
52                         "apps", "open-ils.search", "app_settings", "max_superpages" ) || 20;
53
54         $logger->info("Search cache timeout is $cache_timeout, ".
55         " superpage_size is $superpage_size, max_superpages is $max_superpages");
56 }
57
58
59
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 {
65         my @ids = @_;
66         
67         my @results;
68         my @marcxml_objs;
69
70         my $session = OpenSRF::AppSession->create("open-ils.cstore");
71         my $request = $session->request(
72                         "open-ils.cstore.direct.biblio.record_entry.search", { id => \@ids } );
73
74         while( my $resp = $request->recv ) {
75                 my $content = $resp->content;
76                 next if $content->id == OILS_PRECAT_RECORD;
77                 my $u = OpenILS::Utils::ModsParser->new();
78                 $u->start_mods_batch( $content->marc );
79                 my $mods = $u->finish_mods_batch();
80                 $mods->doc_id($content->id());
81                 $mods->tcn($content->tcn_value);
82                 push @results, $mods;
83         }
84
85         $session->disconnect();
86         return \@results;
87 }
88
89 __PACKAGE__->register_method(
90         method  => "record_id_to_mods",
91         api_name        => "open-ils.search.biblio.record.mods.retrieve",
92         argc            => 1, 
93         note            => "Provide ID, we provide the mods"
94 );
95
96 # converts a record into a mods object with copy counts attached
97 sub record_id_to_mods {
98
99         my( $self, $client, $org_id, $id ) = @_;
100
101         my $mods_list = _records_to_mods( $id );
102         my $mods_obj = $mods_list->[0];
103         my $cmethod = $self->method_lookup(
104                         "open-ils.search.biblio.record.copy_count");
105         my ($count) = $cmethod->run($org_id, $id);
106         $mods_obj->copy_count($count);
107
108         return $mods_obj;
109 }
110
111
112
113 __PACKAGE__->register_method(
114         method  => "record_id_to_mods_slim",
115     authoritative => 1,
116         api_name        => "open-ils.search.biblio.record.mods_slim.retrieve",
117         argc            => 1, 
118         note            => "Provide ID, we provide the mods"
119 );
120
121 # converts a record into a mods object with NO copy counts attached
122 sub record_id_to_mods_slim {
123         my( $self, $client, $id ) = @_;
124         return undef unless defined $id;
125
126         if(ref($id) and ref($id) == 'ARRAY') {
127                 return _records_to_mods( @$id );
128         }
129         my $mods_list = _records_to_mods( $id );
130         my $mods_obj = $mods_list->[0];
131         return OpenILS::Event->new('BIBLIO_RECORD_ENTRY_NOT_FOUND') unless $mods_obj;
132         return $mods_obj;
133 }
134
135
136 # Returns the number of copies attached to a record based on org location
137 __PACKAGE__->register_method(
138         method  => "record_id_to_copy_count",
139         api_name        => "open-ils.search.biblio.record.copy_count",
140 );
141
142 __PACKAGE__->register_method(
143         method  => "record_id_to_copy_count",
144     authoritative => 1,
145         api_name        => "open-ils.search.biblio.record.copy_count.staff",
146 );
147
148 __PACKAGE__->register_method(
149         method  => "record_id_to_copy_count",
150         api_name        => "open-ils.search.biblio.metarecord.copy_count",
151 );
152
153 __PACKAGE__->register_method(
154         method  => "record_id_to_copy_count",
155         api_name        => "open-ils.search.biblio.metarecord.copy_count.staff",
156 );
157 sub record_id_to_copy_count {
158         my( $self, $client, $org_id, $record_id, $format ) = @_;
159
160         return [] unless $record_id;
161         $format = undef if (!$format or $format eq 'all');
162
163         my $method = "open-ils.storage.biblio.record_entry.copy_count.atomic";
164         my $key = "record";
165
166         if($self->api_name =~ /metarecord/) {
167                 $method = "open-ils.storage.metabib.metarecord.copy_count.atomic";
168                 $key = "metarecord";
169         }
170
171         $method =~ s/atomic/staff\.atomic/og if($self->api_name =~ /staff/ );
172
173         my $count = $U->storagereq( $method, 
174                 org_unit => $org_id, $key => $record_id, format => $format );
175
176         return [ sort { $a->{depth} <=> $b->{depth} } @$count ];
177 }
178
179
180
181
182 __PACKAGE__->register_method(
183         method  => "biblio_search_tcn",
184         api_name        => "open-ils.search.biblio.tcn",
185         argc            => 3, 
186         note            => "Retrieve a record by TCN",
187 );
188
189 sub biblio_search_tcn {
190
191         my( $self, $client, $tcn, $include_deleted ) = @_;
192
193         $tcn =~ s/.*?(\w+)\s*$/$1/o;
194
195         my $e = new_editor();
196    my $search = {tcn_value => $tcn};
197    $search->{deleted} = 'f' unless $include_deleted;
198         my $recs = $e->search_biblio_record_entry( $search, {idlist =>1} );
199         
200         return { count => scalar(@$recs), ids => $recs };
201 }
202
203
204 # --------------------------------------------------------------------------------
205
206 __PACKAGE__->register_method(
207         method  => "biblio_barcode_to_copy",
208         api_name        => "open-ils.search.asset.copy.find_by_barcode",);
209 sub biblio_barcode_to_copy { 
210         my( $self, $client, $barcode ) = @_;
211         my( $copy, $evt ) = $U->fetch_copy_by_barcode($barcode);
212         return $evt if $evt;
213         return $copy;
214 }
215
216 __PACKAGE__->register_method(
217         method  => "biblio_id_to_copy",
218         api_name        => "open-ils.search.asset.copy.batch.retrieve",);
219 sub biblio_id_to_copy { 
220         my( $self, $client, $ids ) = @_;
221         $logger->info("Fetching copies @$ids");
222         return $U->cstorereq(
223                 "open-ils.cstore.direct.asset.copy.search.atomic", { id => $ids } );
224 }
225
226
227 __PACKAGE__->register_method(
228         method  => "copy_retrieve", 
229         api_name        => "open-ils.search.asset.copy.retrieve",);
230 sub copy_retrieve {
231         my( $self, $client, $cid ) = @_;
232         my( $copy, $evt ) = $U->fetch_copy($cid);
233         return $evt if $evt;
234         return $copy;
235 }
236
237 __PACKAGE__->register_method(
238         method  => "volume_retrieve", 
239         api_name        => "open-ils.search.asset.call_number.retrieve");
240 sub volume_retrieve {
241         my( $self, $client, $vid ) = @_;
242         my $e = new_editor();
243         my $vol = $e->retrieve_asset_call_number($vid) or return $e->event;
244         return $vol;
245 }
246
247 __PACKAGE__->register_method(
248         method  => "fleshed_copy_retrieve_batch",
249     authoritative => 1,
250         api_name        => "open-ils.search.asset.copy.fleshed.batch.retrieve");
251
252 sub fleshed_copy_retrieve_batch { 
253         my( $self, $client, $ids ) = @_;
254         $logger->info("Fetching fleshed copies @$ids");
255         return $U->cstorereq(
256                 "open-ils.cstore.direct.asset.copy.search.atomic",
257                 { id => $ids },
258                 { flesh => 1, 
259                   flesh_fields => { acp => [ qw/ circ_lib location status stat_cat_entries / ] }
260                 });
261 }
262
263
264 __PACKAGE__->register_method(
265         method  => "fleshed_copy_retrieve",
266         api_name        => "open-ils.search.asset.copy.fleshed.retrieve",);
267
268 sub fleshed_copy_retrieve { 
269         my( $self, $client, $id ) = @_;
270         my( $c, $e) = $U->fetch_fleshed_copy($id);
271         return $e if $e;
272         return $c;
273 }
274
275
276
277 __PACKAGE__->register_method(
278         method => 'fleshed_by_barcode',
279         api_name        => "open-ils.search.asset.copy.fleshed2.find_by_barcode",);
280 sub fleshed_by_barcode {
281         my( $self, $conn, $barcode ) = @_;
282         my $e = new_editor();
283         my $copyid = $e->search_asset_copy(
284                 {barcode => $barcode, deleted => 'f'}, {idlist=>1})->[0]
285                 or return $e->event;
286         return fleshed_copy_retrieve2( $self, $conn, $copyid);
287 }
288
289
290 __PACKAGE__->register_method(
291         method  => "fleshed_copy_retrieve2",
292         api_name        => "open-ils.search.asset.copy.fleshed2.retrieve",);
293
294 sub fleshed_copy_retrieve2 { 
295         my( $self, $client, $id ) = @_;
296         my $e = new_editor();
297         my $copy = $e->retrieve_asset_copy(
298                 [
299                         $id,
300                         { 
301                                 flesh                           => 2,
302                                 flesh_fields    => { 
303                                         acp => [ qw/ location status stat_cat_entry_copy_maps notes age_protect / ],
304                                         ascecm => [ qw/ stat_cat stat_cat_entry / ],
305                                 }
306                         }
307                 ]
308         ) or return $e->event;
309
310         # For backwards compatibility
311         #$copy->stat_cat_entries($copy->stat_cat_entry_copy_maps);
312
313         if( $copy->status->id == OILS_COPY_STATUS_CHECKED_OUT ) {
314                 $copy->circulations(
315                         $e->search_action_circulation( 
316                                 [       
317                                         { target_copy => $copy->id },
318                                         {
319                                                 order_by => { circ => 'xact_start desc' },
320                                                 limit => 1
321                                         }
322                                 ]
323                         )
324                 );
325         }
326
327         return $copy;
328 }
329
330
331 __PACKAGE__->register_method(
332         method => 'flesh_copy_custom',
333         api_name => 'open-ils.search.asset.copy.fleshed.custom'
334 );
335
336 sub flesh_copy_custom {
337         my( $self, $conn, $copyid, $fields ) = @_;
338         my $e = new_editor();
339         my $copy = $e->retrieve_asset_copy(
340                 [
341                         $copyid,
342                         { 
343                                 flesh                           => 1,
344                                 flesh_fields    => { 
345                                         acp => $fields,
346                                 }
347                         }
348                 ]
349         ) or return $e->event;
350         return $copy;
351 }
352
353
354
355
356
357
358 __PACKAGE__->register_method(
359         method  => "biblio_barcode_to_title",
360         api_name        => "open-ils.search.biblio.find_by_barcode",
361 );
362
363 sub biblio_barcode_to_title {
364         my( $self, $client, $barcode ) = @_;
365
366         my $title = $apputils->simple_scalar_request(
367                 "open-ils.storage",
368                 "open-ils.storage.biblio.record_entry.retrieve_by_barcode", $barcode );
369
370         return { ids => [ $title->id ], count => 1 } if $title;
371         return { count => 0 };
372 }
373
374 __PACKAGE__->register_method(
375     method => 'title_id_by_item_barcode',
376     api_name => 'open-ils.search.bib_id.by_barcode'
377 );
378
379 sub title_id_by_item_barcode {
380     my( $self, $conn, $barcode ) = @_;
381     my $e = new_editor();
382     my $copies = $e->search_asset_copy(
383         [
384             { deleted => 'f', barcode => $barcode },
385             {
386                 flesh => 2,
387                 flesh_fields => {
388                     acp => [ 'call_number' ],
389                     acn => [ 'record' ]
390                 }
391             }
392         ]
393     );
394
395     return $e->event unless @$copies;
396     return $$copies[0]->call_number->record->id;
397 }
398
399
400 __PACKAGE__->register_method(
401         method  => "biblio_copy_to_mods",
402         api_name        => "open-ils.search.biblio.copy.mods.retrieve",
403 );
404
405 # takes a copy object and returns it fleshed mods object
406 sub biblio_copy_to_mods {
407         my( $self, $client, $copy ) = @_;
408
409         my $volume = $U->cstorereq( 
410                 "open-ils.cstore.direct.asset.call_number.retrieve",
411                 $copy->call_number() );
412
413         my $mods = _records_to_mods($volume->record());
414         $mods = shift @$mods;
415         $volume->copies([$copy]);
416         push @{$mods->call_numbers()}, $volume;
417
418         return $mods;
419 }
420
421
422 __PACKAGE__->register_method(
423     api_name => 'open-ils.search.biblio.multiclass.query',
424     method => 'multiclass_query',
425     signature => q#
426         @param arghash @see open-ils.search.biblio.multiclass
427         @param query Raw human-readable query string.  
428             Recognized search keys include: 
429                 keyword/kw - search keyword(s)
430                 author/au/name - search author(s)
431                 title/ti - search title
432                 subject/su - search subject
433                 series/se - search series
434                 lang - limit by language (specifiy multiple langs with lang:l1 lang:l2 ...)
435                 site - search at specified org unit, corresponds to actor.org_unit.shortname
436                 sort - sort type (title, author, pubdate)
437                 dir - sort direction (asc, desc)
438                 available - if set to anything other than "false" or "0", limits to available items
439
440                 keyword, title, author, subject, and series support additional search 
441                 subclasses, specified with a "|". For example, "title|proper:gone with the wind" 
442                 For more, see config.metabib_field
443
444         @param docache @see open-ils.search.biblio.multiclass
445     #
446 );
447 __PACKAGE__->register_method(
448     api_name => 'open-ils.search.biblio.multiclass.query.staff',
449     method => 'multiclass_query',
450     signature => '@see open-ils.search.biblio.multiclass.query');
451 __PACKAGE__->register_method(
452     api_name => 'open-ils.search.metabib.multiclass.query',
453     method => 'multiclass_query',
454     signature => '@see open-ils.search.biblio.multiclass.query');
455 __PACKAGE__->register_method(
456     api_name => 'open-ils.search.metabib.multiclass.query.staff',
457     method => 'multiclass_query',
458     signature => '@see open-ils.search.biblio.multiclass.query');
459
460 sub multiclass_query {
461     my($self, $conn, $arghash, $query, $docache) = @_;
462
463     $logger->debug("initial search query => $query");
464     my $orig_query = $query;
465
466     $query =~ s/\+/ /go;
467     $query =~ s/'//go;
468     $query =~ s/^\s+//go;
469
470     # convert convenience classes (e.g. kw for keyword) to the full class name
471     $query =~ s/kw(:|\|)/keyword$1/go;
472     $query =~ s/ti(:|\|)/title$1/go;
473     $query =~ s/au(:|\|)/author$1/go;
474     $query =~ s/su(:|\|)/subject$1/go;
475     $query =~ s/se(:|\|)/series$1/go;
476     $query =~ s/name(:|\|)/author$1/og;
477
478     $logger->debug("cleansed query string => $query");
479     my $search = $arghash->{searches} = {};
480
481     while ($query =~ s/((?:keyword(?:\|\w+)?|title(?:\|\w+)?|author(?:\|\w+)?|subject(?:\|\w+)?|series(?:\|\w+)?|site|dir|sort|lang|available):[^:]+)$//so) {
482         my($type, $value) = split(':', $1);
483         next unless $type and $value;
484
485         $value =~ s/^\s*//og;
486         $value =~ s/\s*$//og;
487         $type = 'sort_dir' if $type eq 'dir';
488
489         if($type eq 'site') {
490             # 'site' is the org shortname.  when using this, we also want 
491             # to search at the requested org's depth
492             my $e = new_editor();
493             if(my $org = $e->search_actor_org_unit({shortname => $value})->[0]) {
494                 $arghash->{org_unit} = $org->id if $org;
495                 $arghash->{depth} = $e->retrieve_actor_org_unit_type($org->ou_type)->depth;
496             } else {
497                 $logger->warn("'site:' query used on invalid org shortname: $value ... ignoring");
498             }
499
500         } elsif($type eq 'available') {
501             # limit to available
502             $arghash->{available} = 1 unless $value eq 'false' or $value eq '0';
503
504         } elsif($type eq 'lang') {
505             # collect languages into an array of languages
506             $arghash->{language} = [] unless $arghash->{language};
507             push(@{$arghash->{language}}, $value);
508
509         } elsif($type =~ /^sort/o) {
510             # sort and sort_dir modifiers
511             $arghash->{$type} = $value;
512
513         } else {
514             # append the search term to the term under construction
515             $search->{$type} =  {} unless $search->{$type};
516             $search->{$type}->{term} =  
517                 ($search->{$type}->{term}) ? $search->{$type}->{term} . " $value" : $value;
518         }
519     }
520
521     if($query) {
522         # This is the front part of the string before any special tokens were parsed. 
523         # Add this data to the default search class
524         my $type = $arghash->{default_class} || 'keyword';
525         $search->{$type} =  {} unless $search->{$type};
526         $search->{$type}->{term} =
527             ($search->{$type}->{term}) ? $search->{$type}->{term} . " $query" : $query;
528     }
529
530     # capture the original limit because the search method alters the limit internally
531     my $ol = $arghash->{limit};
532
533         my $sclient = OpenSRF::Utils::SettingsClient->new;
534
535     (my $method = $self->api_name) =~ s/\.query//o;
536
537     $method =~ s/multiclass/multiclass.staged/
538         if $sclient->config_value(apps => 'open-ils.search',
539             app_settings => 'use_staged_search') =~ /true/i;
540
541
542         $method = $self->method_lookup($method);
543     my ($data) = $method->run($arghash, $docache);
544
545     $arghash->{limit} = $ol if $ol;
546     $data->{compiled_search} = $arghash;
547     $data->{query} = $orig_query;
548
549     $logger->info("compiled search is " . OpenSRF::Utils::JSON->perl2JSON($arghash));
550
551     return $data;
552 }
553
554 __PACKAGE__->register_method(
555         method          => 'cat_search_z_style_wrapper',
556         api_name        => 'open-ils.search.biblio.zstyle',
557         stream          => 1,
558         signature       => q/@see open-ils.search.biblio.multiclass/);
559
560 sub cat_search_z_style_wrapper {
561         my $self = shift;
562         my $client = shift;
563         my $authtoken = shift;
564         my $args = shift;
565
566         my $cstore = OpenSRF::AppSession->connect('open-ils.cstore');
567
568         my $ou = $cstore->request(
569                 'open-ils.cstore.direct.actor.org_unit.search',
570                 { parent_ou => undef }
571         )->gather(1);
572
573         my $result = { service => 'native-evergreen-catalog', records => [] };
574         my $searchhash = { limit => $$args{limit}, offset => $$args{offset}, org_unit => $ou->id };
575
576         $$searchhash{searches}{title}{term} = $$args{search}{title} if $$args{search}{title};
577         $$searchhash{searches}{author}{term} = $$args{search}{author} if $$args{search}{author};
578         $$searchhash{searches}{subject}{term} = $$args{search}{subject} if $$args{search}{subject};
579         $$searchhash{searches}{keyword}{term} = $$args{search}{keyword} if $$args{search}{keyword};
580
581         $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{tcn} if $$args{search}{tcn};
582         $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{isbn} if $$args{search}{isbn};
583         $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{issn} if $$args{search}{issn};
584         $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{publisher} if $$args{search}{publisher};
585         $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{pubdate} if $$args{search}{pubdate};
586         $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{item_type} if $$args{search}{item_type};
587
588         my $list = the_quest_for_knowledge( $self, $client, $searchhash );
589
590         if ($list->{count} > 0) {
591                 $result->{count} = $list->{count};
592
593                 my $records = $cstore->request(
594                         'open-ils.cstore.direct.biblio.record_entry.search.atomic',
595                         { id => [ map { ( $_->[0] ) } @{$list->{ids}} ] }
596                 )->gather(1);
597
598                 for my $rec ( @$records ) {
599                         
600                         my $u = OpenILS::Utils::ModsParser->new();
601                         $u->start_mods_batch( $rec->marc );
602                         my $mods = $u->finish_mods_batch();
603
604                         push @{ $result->{records} }, { mvr => $mods, marcxml => $rec->marc, bibid => $rec->id };
605
606                 }
607
608         }
609
610     $cstore->disconnect();
611         return $result;
612 }
613
614 # ----------------------------------------------------------------------------
615 # These are the main OPAC search methods
616 # ----------------------------------------------------------------------------
617
618 __PACKAGE__->register_method(
619         method          => 'the_quest_for_knowledge',
620         api_name                => 'open-ils.search.biblio.multiclass',
621         signature       => q/
622                 Performs a multi class bilbli or metabib search
623                 @param searchhash A search object layed out like so:
624                         searches : { "$class" : "$value", ...}
625                         org_unit : The org id to focus the search at
626                         depth           : The org depth
627                         limit           : The search limit
628                         offset  : The search offset
629                         format  : The MARC format
630                         sort            : What field to sort the results on [ author | title | pubdate ]
631                         sort_dir        : What direction do we sort? [ asc | desc ]
632                 @return An object of the form 
633                         { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }
634         /
635 );
636
637 __PACKAGE__->register_method(
638         method          => 'the_quest_for_knowledge',
639         api_name                => 'open-ils.search.biblio.multiclass.staff',
640         signature       => q/@see open-ils.search.biblio.multiclass/);
641 __PACKAGE__->register_method(
642         method          => 'the_quest_for_knowledge',
643         api_name                => 'open-ils.search.metabib.multiclass',
644         signature       => q/@see open-ils.search.biblio.multiclass/);
645 __PACKAGE__->register_method(
646         method          => 'the_quest_for_knowledge',
647         api_name                => 'open-ils.search.metabib.multiclass.staff',
648         signature       => q/@see open-ils.search.biblio.multiclass/);
649
650 sub the_quest_for_knowledge {
651         my( $self, $conn, $searchhash, $docache ) = @_;
652
653         return { count => 0 } unless $searchhash and
654                 ref $searchhash->{searches} eq 'HASH';
655
656         my $method = 'open-ils.storage.biblio.multiclass.search_fts';
657         my $ismeta = 0;
658         my @recs;
659
660         if($self->api_name =~ /metabib/) {
661                 $ismeta = 1;
662                 $method =~ s/biblio/metabib/o;
663         }
664
665
666         my $offset      = $searchhash->{offset} || 0;
667         my $limit       = $searchhash->{limit} || 10;
668         my $end         = $offset + $limit - 1;
669
670         # do some simple sanity checking
671         if(!$searchhash->{searches} or
672                 ( !grep { /^(?:title|author|subject|series|keyword)/ } keys %{$searchhash->{searches}} ) ) {
673                 return { count => 0 };
674         }
675
676
677         my $maxlimit = 5000;
678         $searchhash->{offset}   = 0;
679         $searchhash->{limit}            = $maxlimit;
680
681         return { count => 0 } if $offset > $maxlimit;
682
683         my @search;
684         push( @search, ($_ => $$searchhash{$_})) for (sort keys %$searchhash);
685         my $s = OpenSRF::Utils::JSON->perl2JSON(\@search);
686         my $ckey = $pfx . md5_hex($method . $s);
687
688         $logger->info("bib search for: $s");
689
690         $searchhash->{limit} -= $offset;
691
692
693     my $trim = 0;
694         my $result = ($docache) ? search_cache($ckey, $offset, $limit) : undef;
695
696         if(!$result) {
697
698                 $method .= ".staff" if($self->api_name =~ /staff/);
699                 $method .= ".atomic";
700         
701                 for (keys %$searchhash) { 
702                         delete $$searchhash{$_} 
703                                 unless defined $$searchhash{$_}; 
704                 }
705         
706                 $result = $U->storagereq( $method, %$searchhash );
707         $trim = 1;
708
709         } else { 
710                 $docache = 0; 
711         }
712
713         return {count => 0} unless ($result && $$result[0]);
714
715         @recs = @$result;
716
717         my $count = ($ismeta) ? $result->[0]->[3] : $result->[0]->[2];
718
719         if($docache) {
720                 # If we didn't get this data from the cache, put it into the cache
721                 # then return the correct offset of records
722                 $logger->debug("putting search cache $ckey\n");
723                 put_cache($ckey, $count, \@recs);
724         }
725
726     if($trim) {
727         # if we have the full set of data, trim out 
728         # the requested chunk based on limit and offset
729         my @t;
730         for ($offset..$end) {
731             last unless $recs[$_];
732             push(@t, $recs[$_]);
733         }
734         @recs = @t;
735     }
736
737         return { ids => \@recs, count => $count };
738 }
739
740
741 __PACKAGE__->register_method(
742         method          => 'staged_search',
743         api_name        => 'open-ils.search.biblio.multiclass.staged');
744 __PACKAGE__->register_method(
745         method          => 'staged_search',
746         api_name        => 'open-ils.search.biblio.multiclass.staged.staff',
747         signature       => q/@see open-ils.search.biblio.multiclass.staged/);
748 __PACKAGE__->register_method(
749         method          => 'staged_search',
750         api_name        => 'open-ils.search.metabib.multiclass.staged',
751         signature       => q/@see open-ils.search.biblio.multiclass.staged/);
752 __PACKAGE__->register_method(
753         method          => 'staged_search',
754         api_name        => 'open-ils.search.metabib.multiclass.staged.staff',
755         signature       => q/@see open-ils.search.biblio.multiclass.staged/);
756
757 sub staged_search {
758         my($self, $conn, $search_hash, $docache) = @_;
759
760     my $method = ($self->api_name =~ /metabib/) ?
761         'open-ils.storage.metabib.multiclass.staged.search_fts':
762         'open-ils.storage.biblio.multiclass.staged.search_fts';
763
764     $method .= '.staff' if $self->api_name =~ /staff$/;
765     $method .= '.atomic';
766
767     my $user_offset = $search_hash->{offset} || 0; # user-specified offset
768     my $user_limit = $search_hash->{limit} || 10;
769     $user_offset = ($user_offset >= 0) ? $user_offset : 0;
770     $user_limit = ($user_limit >= 0) ? $user_limit : 10;
771
772
773     # we're grabbing results on a per-superpage basis, which means the 
774     # limit and offset should coincide with superpage boundaries
775     $search_hash->{offset} = 0;
776     $search_hash->{limit} = $superpage_size;
777
778     # force a well-known check_limit
779     $search_hash->{check_limit} = $superpage_size; 
780     # restrict total tested to superpage size * number of superpages
781     $search_hash->{core_limit} = $superpage_size * $max_superpages;
782
783     # Set the configured estimation strategy, defaults to 'inclusion'.
784         my $estimation_strategy = OpenSRF::Utils::SettingsClient
785         ->new
786         ->config_value(
787             apps => 'open-ils.search', app_settings => 'estimation_strategy'
788         ) || 'inclusion';
789         $search_hash->{estimation_strategy} = $estimation_strategy;
790
791     # pull any existing results from the cache
792     my $key = search_cache_key($method, $search_hash);
793     my $cache_data = $cache->get_cache($key) || {};
794
795     # keep retrieving results until we find enough to 
796     # fulfill the user-specified limit and offset
797     my $all_results = [];
798     my $page; # current superpage
799     my $est_hit_count = 0;
800     my $current_page_summary = {};
801     my $global_summary = {checked => 0, visible => 0, excluded => 0, deleted => 0, total => 0};
802
803     for($page = 0; $page < $max_superpages; $page++) {
804
805         my $data = $cache_data->{$page};
806         my $results;
807         my $summary;
808
809         $logger->debug("staged search: analyzing superpage $page");
810
811         if($data) {
812             # this window of results is already cached
813             $logger->debug("staged search: found cached results");
814             $summary = $data->{summary};
815             $results = $data->{results};
816
817         } else {
818             # retrieve the window of results from the database
819             $logger->debug("staged search: fetching results from the database");
820             $search_hash->{skip_check} = $page * $superpage_size;
821             my $start = time;
822             $results = $U->storagereq($method, %$search_hash);
823             $logger->info("staged search: DB call took ".(time - $start)." seconds");
824             $summary = shift(@$results);
825
826             # Create backwards-compatible result structures
827             if($self->api_name =~ /biblio/) {
828                 $results = [map {[$_->{id}]} @$results];
829             } else {
830                 $results = [map {[$_->{id}, $_->{rel}, $_->{record}]} @$results];
831             }
832
833             $results = [grep {defined $_->[0]} @$results];
834             cache_staged_search_page($key, $page, $summary, $results) if $docache;
835         }
836
837         $current_page_summary = $summary;
838
839         # add the new set of results to the set under construction
840         push(@$all_results, @$results);
841
842         my $current_count = scalar(@$all_results);
843
844         $est_hit_count = $summary->{estimated_hit_count} || $summary->{visible}
845             if $page == 0;
846
847         $logger->debug("staged search: located $current_count, with estimated hits=".
848             $summary->{estimated_hit_count}." : visible=".$summary->{visible}.", checked=".$summary->{checked});
849
850                 if (defined($summary->{estimated_hit_count})) {
851                         $global_summary->{checked} += $summary->{checked};
852                         $global_summary->{visible} += $summary->{visible};
853                         $global_summary->{excluded} += $summary->{excluded};
854                         $global_summary->{deleted} += $summary->{deleted};
855                         $global_summary->{total} = $summary->{total};
856                 }
857
858         # we've found all the possible hits
859         last if $current_count == $summary->{visible}
860             and not defined $summary->{estimated_hit_count};
861
862         # we've found enough results to satisfy the requested limit/offset
863         last if $current_count >= ($user_limit + $user_offset);
864
865         # we've scanned all possible hits
866         last if $summary->{checked} < $superpage_size;
867     }
868
869     my @results = grep {defined $_} @$all_results[$user_offset..($user_offset + $user_limit - 1)];
870
871         # refine the estimate if we have more than one superpage
872         if ($page > 0) {
873                 if ($global_summary->{checked} >= $global_summary->{total}) {
874                         $est_hit_count = $global_summary->{visible};
875                 } else {
876                         my $updated_hit_count = $U->storagereq(
877                                 'open-ils.storage.fts_paging_estimate',
878                                 $global_summary->{checked},
879                                 $global_summary->{visible},
880                                 $global_summary->{excluded},
881                                 $global_summary->{deleted},
882                                 $global_summary->{total}
883                         );
884                         $est_hit_count = $updated_hit_count->{$estimation_strategy};
885                 }
886         }
887
888     return {
889         count => $est_hit_count,
890         core_limit => $search_hash->{core_limit},
891         superpage_size => $search_hash->{check_limit},
892         superpage_summary => $current_page_summary,
893         ids => \@results
894     };
895 }
896
897 # creates a unique token to represent the query in the cache
898 sub search_cache_key {
899     my $method = shift;
900     my $search_hash = shift;
901         my @sorted;
902     for my $key (sort keys %$search_hash) {
903             push(@sorted, ($key => $$search_hash{$key})) 
904             unless $key eq 'limit' or 
905                 $key eq 'offset' or 
906                 $key eq 'skip_check';
907     }
908         my $s = OpenSRF::Utils::JSON->perl2JSON(\@sorted);
909         return $pfx . md5_hex($method . $s);
910 }
911
912 sub cache_staged_search_page {
913     # puts this set of results into the cache
914     my($key, $page, $summary, $results) = @_;
915     my $data = $cache->get_cache($key);
916     $data ||= {};
917     $data->{$page} = {
918         summary => $summary,
919         results => $results
920     };
921
922     $logger->info("staged search: cached with key=$key, superpage=$page, estimated=".
923         $summary->{estimated_hit_count}.", visible=".$summary->{visible});
924
925     $cache->put_cache($key, $data);
926 }
927
928 sub search_cache {
929
930         my $key         = shift;
931         my $offset      = shift;
932         my $limit       = shift;
933         my $start       = $offset;
934         my $end         = $offset + $limit - 1;
935
936         $logger->debug("searching cache for $key : $start..$end\n");
937
938         return undef unless $cache;
939         my $data = $cache->get_cache($key);
940
941         return undef unless $data;
942
943         my $count = $data->[0];
944         $data = $data->[1];
945
946         return undef unless $offset < $count;
947
948         my @result;
949         for( my $i = $offset; $i <= $end; $i++ ) {
950                 last unless my $d = $$data[$i];
951                 push( @result, $d );
952         }
953
954         $logger->debug("search_cache found ".scalar(@result)." items for count=$count, start=$start, end=$end");
955
956         return \@result;
957 }
958
959
960 sub put_cache {
961         my( $key, $count, $data ) = @_;
962         return undef unless $cache;
963         $logger->debug("search_cache putting ".
964                 scalar(@$data)." items at key $key with timeout $cache_timeout");
965         $cache->put_cache($key, [ $count, $data ], $cache_timeout);
966 }
967
968
969
970
971
972
973 __PACKAGE__->register_method(
974         method  => "biblio_mrid_to_modsbatch_batch",
975         api_name        => "open-ils.search.biblio.metarecord.mods_slim.batch.retrieve");
976
977 sub biblio_mrid_to_modsbatch_batch {
978         my( $self, $client, $mrids) = @_;
979         warn "Performing mrid_to_modsbatch_batch...";
980         my @mods;
981         my $method = $self->method_lookup("open-ils.search.biblio.metarecord.mods_slim.retrieve");
982         for my $id (@$mrids) {
983                 next unless defined $id;
984                 my ($m) = $method->run($id);
985                 push @mods, $m;
986         }
987         return \@mods;
988 }
989
990
991 __PACKAGE__->register_method(
992         method  => "biblio_mrid_to_modsbatch",
993         api_name        => "open-ils.search.biblio.metarecord.mods_slim.retrieve",
994         notes           => <<"  NOTES");
995         Returns the mvr associated with a given metarecod. If none exists, 
996         it is created.
997         NOTES
998
999 __PACKAGE__->register_method(
1000         method  => "biblio_mrid_to_modsbatch",
1001         api_name        => "open-ils.search.biblio.metarecord.mods_slim.retrieve.staff",
1002         notes           => <<"  NOTES");
1003         Returns the mvr associated with a given metarecod. If none exists, 
1004         it is created.
1005         NOTES
1006
1007 sub biblio_mrid_to_modsbatch {
1008         my( $self, $client, $mrid, $args) = @_;
1009
1010         warn "Grabbing mvr for $mrid\n";
1011
1012         my ($mr, $evt) = _grab_metarecord($mrid);
1013         return $evt unless $mr;
1014
1015         my $mvr = biblio_mrid_check_mvr($self, $client, $mr);
1016         $mvr = biblio_mrid_make_modsbatch( $self, $client, $mr ) unless $mvr;
1017
1018         return $mvr unless ref($args);  
1019
1020         # Here we find the lead record appropriate for the given filters 
1021         # and use that for the title and author of the metarecord
1022         my $format      = $$args{format};
1023         my $org         = $$args{org};
1024         my $depth       = $$args{depth};
1025
1026         return $mvr unless $format or $org or $depth;
1027
1028         my $method = "open-ils.storage.ordered.metabib.metarecord.records";
1029         $method = "$method.staff" if $self->api_name =~ /staff/o; 
1030
1031         my $rec = $U->storagereq($method, $format, $org, $depth, 1);
1032
1033         if( my $mods = $U->record_to_mvr($rec) ) {
1034
1035                 $mvr->title($mods->title);
1036                 $mvr->title($mods->author);
1037                 $logger->debug("mods_slim updating title and ".
1038                         "author in mvr with ".$mods->title." : ".$mods->author);
1039         }
1040
1041         return $mvr;
1042 }
1043
1044 # converts a metarecord to an mvr
1045 sub _mr_to_mvr {
1046         my $mr = shift;
1047         my $perl = OpenSRF::Utils::JSON->JSON2perl($mr->mods());
1048         return Fieldmapper::metabib::virtual_record->new($perl);
1049 }
1050
1051 # checks to see if a metarecord has mods, if so returns true;
1052
1053 __PACKAGE__->register_method(
1054         method  => "biblio_mrid_check_mvr",
1055         api_name        => "open-ils.search.biblio.metarecord.mods_slim.check",
1056         notes           => <<"  NOTES");
1057         Takes a metarecord ID or a metarecord object and returns true
1058         if the metarecord already has an mvr associated with it.
1059         NOTES
1060
1061 sub biblio_mrid_check_mvr {
1062         my( $self, $client, $mrid ) = @_;
1063         my $mr; 
1064
1065         my $evt;
1066         if(ref($mrid)) { $mr = $mrid; } 
1067         else { ($mr, $evt) = _grab_metarecord($mrid); }
1068         return $evt if $evt;
1069
1070         warn "Checking mvr for mr " . $mr->id . "\n";
1071
1072         return _mr_to_mvr($mr) if $mr->mods();
1073         return undef;
1074 }
1075
1076 sub _grab_metarecord {
1077         my $mrid = shift;
1078         #my $e = OpenILS::Utils::Editor->new;
1079         my $e = new_editor();
1080         my $mr = $e->retrieve_metabib_metarecord($mrid) or return ( undef, $e->event );
1081         return ($mr);
1082 }
1083
1084
1085 __PACKAGE__->register_method(
1086         method  => "biblio_mrid_make_modsbatch",
1087         api_name        => "open-ils.search.biblio.metarecord.mods_slim.create",
1088         notes           => <<"  NOTES");
1089         Takes either a metarecord ID or a metarecord object.
1090         Forces the creations of an mvr for the given metarecord.
1091         The created mvr is returned.
1092         NOTES
1093
1094 sub biblio_mrid_make_modsbatch {
1095         my( $self, $client, $mrid ) = @_;
1096
1097         #my $e = OpenILS::Utils::Editor->new;
1098         my $e = new_editor();
1099
1100         my $mr;
1101         if( ref($mrid) ) {
1102                 $mr = $mrid;
1103                 $mrid = $mr->id;
1104         } else {
1105                 $mr = $e->retrieve_metabib_metarecord($mrid) 
1106                         or return $e->event;
1107         }
1108
1109         my $masterid = $mr->master_record;
1110         $logger->info("creating new mods batch for metarecord=$mrid, master record=$masterid");
1111
1112         my $ids = $U->storagereq(
1113                 'open-ils.storage.ordered.metabib.metarecord.records.staff.atomic', $mrid);
1114         return undef unless @$ids;
1115
1116         my $master = $e->retrieve_biblio_record_entry($masterid)
1117                 or return $e->event;
1118
1119         # start the mods batch
1120         my $u = OpenILS::Utils::ModsParser->new();
1121         $u->start_mods_batch( $master->marc );
1122
1123         # grab all of the sub-records and shove them into the batch
1124         my @ids = grep { $_ ne $masterid } @$ids;
1125         #my $subrecs = (@ids) ? $e->batch_retrieve_biblio_record_entry(\@ids) : [];
1126
1127         my $subrecs = [];
1128         if(@$ids) {
1129                 for my $i (@$ids) {
1130                         my $r = $e->retrieve_biblio_record_entry($i);
1131                         push( @$subrecs, $r ) if $r;
1132                 }
1133         }
1134
1135         for(@$subrecs) {
1136                 $logger->debug("adding record ".$_->id." to mods batch for metarecord=$mrid");
1137                 $u->push_mods_batch( $_->marc ) if $_->marc;
1138         }
1139
1140
1141         # finish up and send to the client
1142         my $mods = $u->finish_mods_batch();
1143         $mods->doc_id($mrid);
1144         $client->respond_complete($mods);
1145
1146
1147         # now update the mods string in the db
1148         my $string = OpenSRF::Utils::JSON->perl2JSON($mods->decast);
1149         $mr->mods($string);
1150
1151         #$e = OpenILS::Utils::Editor->new(xact => 1);
1152         $e = new_editor(xact => 1);
1153         $e->update_metabib_metarecord($mr) 
1154                 or $logger->error("Error setting mods text on metarecord $mrid : " . Dumper($e->event));
1155         $e->finish;
1156
1157         return undef;
1158 }
1159
1160
1161
1162
1163 # converts a mr id into a list of record ids
1164
1165 __PACKAGE__->register_method(
1166         method  => "biblio_mrid_to_record_ids",
1167         api_name        => "open-ils.search.biblio.metarecord_to_records",
1168 );
1169
1170 __PACKAGE__->register_method(
1171         method  => "biblio_mrid_to_record_ids",
1172         api_name        => "open-ils.search.biblio.metarecord_to_records.staff",
1173 );
1174
1175 sub biblio_mrid_to_record_ids {
1176         my( $self, $client, $mrid, $args ) = @_;
1177
1178         my $format      = $$args{format};
1179         my $org         = $$args{org};
1180         my $depth       = $$args{depth};
1181
1182         my $method = "open-ils.storage.ordered.metabib.metarecord.records.atomic";
1183         $method =~ s/atomic/staff\.atomic/o if $self->api_name =~ /staff/o; 
1184         my $recs = $U->storagereq($method, $mrid, $format, $org, $depth);
1185
1186         return { count => scalar(@$recs), ids => $recs };
1187 }
1188
1189
1190 __PACKAGE__->register_method(
1191         method  => "biblio_record_to_marc_html",
1192         api_name        => "open-ils.search.biblio.record.html" );
1193
1194 my $parser              = XML::LibXML->new();
1195 my $xslt                        = XML::LibXSLT->new();
1196 my $marc_sheet;
1197
1198 my $settings_client = OpenSRF::Utils::SettingsClient->new();
1199 sub biblio_record_to_marc_html {
1200         my( $self, $client, $recordid ) = @_;
1201
1202         if( !$marc_sheet ) {
1203                 my $dir = $settings_client->config_value( "dirs", "xsl" );
1204                 my $xsl = $settings_client->config_value(
1205                         "apps", "open-ils.search", "app_settings", "marc_html_xsl" );
1206
1207                 $xsl = $parser->parse_file("$dir/$xsl");
1208                 $marc_sheet = $xslt->parse_stylesheet( $xsl );
1209         }
1210
1211
1212         my $record = $apputils->simple_scalar_request(
1213                 "open-ils.cstore", 
1214                 "open-ils.cstore.direct.biblio.record_entry.retrieve",
1215                 $recordid );
1216
1217         my $xmldoc = $parser->parse_string($record->marc);
1218         my $html = $marc_sheet->transform($xmldoc);
1219         $html = $html->toString();
1220         return $html;
1221
1222 }
1223
1224
1225 =head duplicate
1226 __PACKAGE__->register_method(
1227         method  => "retrieve_all_copy_locations",
1228         api_name        => "open-ils.search.config.copy_location.retrieve.all" );
1229
1230 my $shelving_locations;
1231 sub retrieve_all_copy_locations {
1232         my( $self, $client ) = @_;
1233         if(!$shelving_locations) {
1234                 $shelving_locations = $apputils->simple_scalar_request(
1235                         "open-ils.cstore", 
1236                         "open-ils.cstore.direct.asset.copy_location.search.atomic",
1237                         { id => { "!=" => undef } }
1238                 );
1239         }
1240         return $shelving_locations;
1241 }
1242 =cut
1243
1244
1245
1246 __PACKAGE__->register_method(
1247         method  => "retrieve_all_copy_statuses",
1248         api_name        => "open-ils.search.config.copy_status.retrieve.all" );
1249
1250 my $copy_statuses;
1251 sub retrieve_all_copy_statuses {
1252         my( $self, $client ) = @_;
1253         return $copy_statuses if $copy_statuses;
1254         return $copy_statuses = 
1255                 new_editor()->retrieve_all_config_copy_status();
1256 }
1257
1258
1259 __PACKAGE__->register_method(
1260         method  => "copy_counts_per_org",
1261         api_name        => "open-ils.search.biblio.copy_counts.retrieve");
1262
1263 __PACKAGE__->register_method(
1264         method  => "copy_counts_per_org",
1265         api_name        => "open-ils.search.biblio.copy_counts.retrieve.staff");
1266
1267 sub copy_counts_per_org {
1268         my( $self, $client, $record_id ) = @_;
1269
1270         warn "Retreiveing copy copy counts for record $record_id and method " . $self->api_name . "\n";
1271
1272         my $method = "open-ils.storage.biblio.record_entry.global_copy_count.atomic";
1273         if($self->api_name =~ /staff/) { $method =~ s/atomic/staff\.atomic/; }
1274
1275         my $counts = $apputils->simple_scalar_request(
1276                 "open-ils.storage", $method, $record_id );
1277
1278         $counts = [ sort {$a->[0] <=> $b->[0]} @$counts ];
1279         return $counts;
1280 }
1281
1282
1283 __PACKAGE__->register_method(
1284         method          => "copy_count_summary",
1285         api_name        => "open-ils.search.biblio.copy_counts.summary.retrieve",
1286         notes           => <<"  NOTES");
1287         returns an array of these:
1288                 [ org_id, callnumber_label, <status1_count>, <status2_cout>,...]
1289                 where statusx is a copy status name.  the statuses are sorted
1290                 by id.
1291         NOTES
1292
1293 sub copy_count_summary {
1294         my( $self, $client, $rid, $org, $depth ) = @_;
1295         $org ||= 1;
1296         $depth ||= 0;
1297     my $data = $U->storagereq(
1298                 'open-ils.storage.biblio.record_entry.status_copy_count.atomic', $rid, $org, $depth );
1299
1300     return [ sort { $a->[1] cmp $b->[1] } @$data ];
1301 }
1302
1303
1304
1305 =head
1306 __PACKAGE__->register_method(
1307         method          => "multiclass_search",
1308         api_name        => "open-ils.search.biblio.multiclass",
1309         notes           => <<"  NOTES");
1310                 Performs a multiclass search
1311                 PARAMS( searchBlob, org_unit, format, limit ) 
1312                 where searchBlob is defined like this:
1313                         { 
1314                                 "title" : { "term" : "water" }, 
1315                                 "author" : { "term" : "smith" }, 
1316                                 ... 
1317                         }
1318         NOTES
1319
1320 __PACKAGE__->register_method(
1321         method          => "multiclass_search",
1322         api_name        => "open-ils.search.biblio.multiclass.staff",
1323         notes           => "see open-ils.search.biblio.multiclass" );
1324
1325 sub multiclass_search {
1326         my( $self, $client, $searchBlob, $orgid, $format, $limit ) = @_;
1327
1328         $logger->debug("Performing multiclass search with org => $orgid, " .
1329                 "format => $format, limit => $limit, and search blob " . Dumper($searchBlob));
1330
1331         my $meth = 'open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.atomic';
1332         if($self->api_name =~ /staff/) { $meth =~ s/metarecord\.atomic/metarecord.staff.atomic/; }
1333
1334
1335         my $records = $apputils->simplereq(
1336                 'open-ils.storage', $meth, 
1337                  org_unit => $orgid, searches => $searchBlob, format => $format, limit => $limit );
1338
1339         my $count = 0;
1340         my $recs = [];
1341
1342         if( ref($records) and $records->[0] and 
1343                 defined($records->[0]->[3])) { $count = $records->[0]->[3];}
1344
1345         for my $r (@$records) { push( @$recs, $r ) if ($r and $r->[0]); }
1346
1347         # records has the form: [ mrid, rank, singleRecord / 0, hitCount ];
1348         return { ids => $recs, count => $count };
1349 }
1350 =cut
1351
1352
1353 =head comment-1
1354 __PACKAGE__->register_method(
1355         method          => "multiclass_search",
1356         api_name                => "open-ils.search.biblio.multiclass",
1357         signature       => q/
1358                 Performs a multiclass search
1359                 @param args A names hash of arguments:
1360                         org_unit : The org to focus the search on
1361                         depth           : The search depth
1362                         format  : Item format
1363                         limit           : Return limit
1364                         offset  : Search offset
1365                         searches : A named hash of searches which has the following format:
1366                                 { 
1367                                         "title" : { "term" : "water" }, 
1368                                         "author" : { "term" : "smith" }, 
1369                                         ... 
1370                                 }
1371                 @return { ids : <array of ids>, count : hitcount }
1372         /
1373 );
1374
1375 __PACKAGE__->register_method(
1376         method          => "multiclass_search",
1377         api_name                => "open-ils.search.biblio.multiclass.staff",
1378         notes           => q/@see open-ils.search.biblio.multiclass/ );
1379
1380 sub multiclass_search {
1381         my( $self, $client, $args ) = @_;
1382
1383         $logger->debug("Performing multiclass search with args:\n" . Dumper($args));
1384         my $meth = 'open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.atomic';
1385         if($self->api_name =~ /staff/) { $meth =~ s/metarecord\.atomic/metarecord.staff.atomic/; }
1386
1387         my $records = $apputils->simplereq( 'open-ils.storage', $meth, %$args );
1388
1389         my $count = 0;
1390         my $recs = [];
1391
1392         if( ref($records) and $records->[0] and 
1393                 defined($records->[0]->[3])) { $count = $records->[0]->[3];}
1394
1395         for my $r (@$records) { push( @$recs, $r ) if ($r and $r->[0]); }
1396
1397         return { ids => $recs, count => $count };
1398 }
1399
1400 =cut
1401
1402
1403
1404 __PACKAGE__->register_method(
1405         method          => "marc_search",
1406         api_name        => "open-ils.search.biblio.marc.staff");
1407
1408 __PACKAGE__->register_method(
1409         method          => "marc_search",
1410         api_name        => "open-ils.search.biblio.marc",
1411         notes           => <<"  NOTES");
1412                 Example:
1413                 open-ils.storage.biblio.full_rec.multi_search.atomic 
1414                 { "searches": [{"term":"harry","restrict": [{"tag":245,"subfield":"a"}]}], "org_unit": 1,
1415         "limit":5,"sort":"author","item_type":"g"}
1416         NOTES
1417
1418 sub marc_search {
1419         my( $self, $conn, $args, $limit, $offset ) = @_;
1420
1421         my $method = 'open-ils.storage.biblio.full_rec.multi_search';
1422         $method .= ".staff" if $self->api_name =~ /staff/;
1423         $method .= ".atomic";
1424
1425         $limit ||= 10;
1426         $offset ||= 0;
1427
1428         my @search;
1429         push( @search, ($_ => $$args{$_}) ) for (sort keys %$args);
1430         my $ckey = $pfx . md5_hex($method . OpenSRF::Utils::JSON->perl2JSON(\@search));
1431
1432         my $recs = search_cache($ckey, $offset, $limit);
1433
1434         if(!$recs) {
1435                 $recs = $U->storagereq($method, %$args) || [];
1436                 if( $recs ) {
1437                         put_cache($ckey, scalar(@$recs), $recs);
1438                         $recs = [ @$recs[$offset..($offset + ($limit - 1))] ];
1439                 } else {
1440                         $recs = [];
1441                 }
1442         }
1443
1444         my $count = 0;
1445         $count = $recs->[0]->[2] if $recs->[0] and $recs->[0]->[2];
1446         my @recs = map { $_->[0] } @$recs;
1447
1448         return { ids => \@recs, count => $count };
1449 }
1450
1451
1452 __PACKAGE__->register_method(
1453         method  => "biblio_search_isbn",
1454         api_name        => "open-ils.search.biblio.isbn",
1455 );
1456
1457 sub biblio_search_isbn { 
1458         my( $self, $client, $isbn ) = @_;
1459         $logger->debug("Searching ISBN $isbn");
1460         my $e = new_editor();
1461         my $recs = $U->storagereq(
1462                 'open-ils.storage.id_list.biblio.record_entry.search.isbn.atomic', $isbn );
1463         return { ids => $recs, count => scalar(@$recs) };
1464 }
1465
1466
1467 __PACKAGE__->register_method(
1468         method  => "biblio_search_issn",
1469         api_name        => "open-ils.search.biblio.issn",
1470 );
1471
1472 sub biblio_search_issn { 
1473         my( $self, $client, $issn ) = @_;
1474         $logger->debug("Searching ISSN $issn");
1475         my $e = new_editor();
1476         my $recs = $U->storagereq(
1477                 'open-ils.storage.id_list.biblio.record_entry.search.issn.atomic', $issn );
1478         return { ids => $recs, count => scalar(@$recs) };
1479 }
1480
1481
1482
1483
1484 __PACKAGE__->register_method(
1485         method  => "fetch_mods_by_copy",
1486         api_name        => "open-ils.search.biblio.mods_from_copy",
1487 );
1488
1489 sub fetch_mods_by_copy {
1490         my( $self, $client, $copyid ) = @_;
1491         my ($record, $evt) = $apputils->fetch_record_by_copy( $copyid );
1492         return $evt if $evt;
1493         return OpenILS::Event->new('ITEM_NOT_CATALOGED') unless $record->marc;
1494         return $apputils->record_to_mvr($record);
1495 }
1496
1497
1498
1499 # -------------------------------------------------------------------------------------
1500
1501 __PACKAGE__->register_method(
1502         method  => "cn_browse",
1503         api_name        => "open-ils.search.callnumber.browse.target",
1504         notes           => "Starts a callnumber browse"
1505         );
1506
1507 __PACKAGE__->register_method(
1508         method  => "cn_browse",
1509         api_name        => "open-ils.search.callnumber.browse.page_up",
1510         notes           => "Returns the previous page of callnumbers", 
1511         );
1512
1513 __PACKAGE__->register_method(
1514         method  => "cn_browse",
1515         api_name        => "open-ils.search.callnumber.browse.page_down",
1516         notes           => "Returns the next page of callnumbers", 
1517         );
1518
1519
1520 # RETURNS array of arrays like so: label, owning_lib, record, id
1521 sub cn_browse {
1522         my( $self, $client, @params ) = @_;
1523         my $method;
1524
1525         $method = 'open-ils.storage.asset.call_number.browse.target.atomic' 
1526                 if( $self->api_name =~ /target/ );
1527         $method = 'open-ils.storage.asset.call_number.browse.page_up.atomic'
1528                 if( $self->api_name =~ /page_up/ );
1529         $method = 'open-ils.storage.asset.call_number.browse.page_down.atomic'
1530                 if( $self->api_name =~ /page_down/ );
1531
1532         return $apputils->simplereq( 'open-ils.storage', $method, @params );
1533 }
1534 # -------------------------------------------------------------------------------------
1535
1536 __PACKAGE__->register_method(
1537         method => "fetch_cn",
1538     authoritative => 1,
1539         api_name => "open-ils.search.callnumber.retrieve",
1540         notes           => "retrieves a callnumber based on ID",
1541         );
1542
1543 sub fetch_cn {
1544         my( $self, $client, $id ) = @_;
1545         my( $cn, $evt ) = $apputils->fetch_callnumber( $id );
1546         return $evt if $evt;
1547         return $cn;
1548 }
1549
1550 __PACKAGE__->register_method (
1551         method          => "fetch_copy_by_cn",
1552         api_name                => 'open-ils.search.copies_by_call_number.retrieve',
1553         signature       => q/
1554                 Returns an array of copy id's by callnumber id
1555                 @param cnid The callnumber id
1556                 @return An array of copy ids
1557         /
1558 );
1559
1560 sub fetch_copy_by_cn {
1561         my( $self, $conn, $cnid ) = @_;
1562         return $U->cstorereq(
1563                 'open-ils.cstore.direct.asset.copy.id_list.atomic', 
1564                 { call_number => $cnid, deleted => 'f' } );
1565 }
1566
1567 __PACKAGE__->register_method (
1568         method          => 'fetch_cn_by_info',
1569         api_name                => 'open-ils.search.call_number.retrieve_by_info',
1570         signature       => q/
1571                 @param label The callnumber label
1572                 @param record The record the cn is attached to
1573                 @param org The owning library of the cn
1574                 @return The callnumber object
1575         /
1576 );
1577
1578
1579 sub fetch_cn_by_info {
1580         my( $self, $conn, $label, $record, $org ) = @_;
1581         return $U->cstorereq(
1582                 'open-ils.cstore.direct.asset.call_number.search',
1583                 { label => $label, record => $record, owning_lib => $org, deleted => 'f' });
1584 }
1585
1586
1587                 
1588
1589
1590 __PACKAGE__->register_method (
1591         method => 'bib_extras',
1592         api_name => 'open-ils.search.biblio.lit_form_map.retrieve.all');
1593 __PACKAGE__->register_method (
1594         method => 'bib_extras',
1595         api_name => 'open-ils.search.biblio.item_form_map.retrieve.all');
1596 __PACKAGE__->register_method (
1597         method => 'bib_extras',
1598         api_name => 'open-ils.search.biblio.item_type_map.retrieve.all');
1599 __PACKAGE__->register_method (
1600         method => 'bib_extras',
1601         api_name => 'open-ils.search.biblio.bib_level_map.retrieve.all');
1602 __PACKAGE__->register_method (
1603         method => 'bib_extras',
1604         api_name => 'open-ils.search.biblio.audience_map.retrieve.all');
1605
1606 sub bib_extras {
1607         my $self = shift;
1608
1609         my $e = new_editor();
1610
1611         return $e->retrieve_all_config_lit_form_map()
1612                 if( $self->api_name =~ /lit_form/ );
1613
1614         return $e->retrieve_all_config_item_form_map()
1615                 if( $self->api_name =~ /item_form_map/ );
1616
1617         return $e->retrieve_all_config_item_type_map()
1618                 if( $self->api_name =~ /item_type_map/ );
1619
1620         return $e->retrieve_all_config_bib_level_map()
1621                 if( $self->api_name =~ /bib_level_map/ );
1622
1623         return $e->retrieve_all_config_audience_map()
1624                 if( $self->api_name =~ /audience_map/ );
1625
1626         return [];
1627 }
1628
1629
1630
1631 __PACKAGE__->register_method(
1632         method  => 'fetch_slim_record',
1633         api_name        => 'open-ils.search.biblio.record_entry.slim.retrieve',
1634         signature=> q/
1635                 Returns a biblio.record_entry without the attached marcxml
1636         /
1637 );
1638
1639 sub fetch_slim_record {
1640         my( $self, $conn, $ids ) = @_;
1641
1642         #my $editor = OpenILS::Utils::Editor->new;
1643         my $editor = new_editor();
1644         my @res;
1645         for( @$ids ) {
1646                 return $editor->event unless
1647                         my $r = $editor->retrieve_biblio_record_entry($_);
1648                 $r->clear_marc;
1649                 push(@res, $r);
1650         }
1651         return \@res;
1652 }
1653
1654
1655
1656 __PACKAGE__->register_method(
1657         method => 'rec_to_mr_rec_descriptors',
1658         api_name        => 'open-ils.search.metabib.record_to_descriptors',
1659         signature       => q/
1660                 specialized method...
1661                 Given a biblio record id or a metarecord id, 
1662                 this returns a list of metabib.record_descriptor
1663                 objects that live within the same metarecord
1664                 @param args Object of args including:
1665         /
1666 );
1667
1668 sub rec_to_mr_rec_descriptors {
1669         my( $self, $conn, $args ) = @_;
1670
1671         my $rec = $$args{record};
1672         my $mrec        = $$args{metarecord};
1673         my $item_forms = $$args{item_forms};
1674         my $item_types  = $$args{item_types};
1675         my $item_lang   = $$args{item_lang};
1676
1677         my $e = new_editor();
1678         my $recs;
1679
1680         if( !$mrec ) {
1681                 my $map = $e->search_metabib_metarecord_source_map({source => $rec});
1682                 return $e->event unless @$map;
1683                 $mrec = $$map[0]->metarecord;
1684         }
1685
1686         $recs = $e->search_metabib_metarecord_source_map({metarecord => $mrec});
1687         return $e->event unless @$recs;
1688
1689         my @recs = map { $_->source } @$recs;
1690         my $search = { record => \@recs };
1691         $search->{item_form} = $item_forms if $item_forms and @$item_forms;
1692         $search->{item_type} = $item_types if $item_types and @$item_types;
1693         $search->{item_lang} = $item_lang if $item_lang;
1694
1695         my $desc = $e->search_metabib_record_descriptor($search);
1696
1697         return { metarecord => $mrec, descriptors => $desc };
1698 }
1699
1700
1701
1702
1703 __PACKAGE__->register_method(
1704         method => 'copies_created_on',  
1705 );
1706
1707
1708 sub copies_created_on {
1709         my( $self, $conn, $auth, $org, $date ) = @_;
1710         my $e = new_editor(authtoken=>$auth);
1711         return $e->event unless $e->checkauth;
1712 }
1713
1714
1715 __PACKAGE__->register_method(
1716         method => 'fetch_age_protect',
1717         api_name => 'open-ils.search.copy.age_protect.retrieve.all',
1718 );
1719
1720 sub fetch_age_protect {
1721         return new_editor()->retrieve_all_config_rule_age_hold_protect();
1722 }
1723
1724
1725 __PACKAGE__->register_method(
1726         method => 'copies_by_cn_label',
1727         api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label',
1728 );
1729
1730 __PACKAGE__->register_method(
1731         method => 'copies_by_cn_label',
1732         api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label.staff',
1733 );
1734
1735 sub copies_by_cn_label {
1736         my( $self, $conn, $record, $label, $circ_lib ) = @_;
1737         my $e = new_editor();
1738         my $cns = $e->search_asset_call_number({record => $record, label => $label, deleted => 'f'}, {idlist=>1});
1739         return [] unless @$cns;
1740
1741         # show all non-deleted copies in the staff client ...
1742         if ($self->api_name =~ /staff$/o) {
1743                 return $e->search_asset_copy({call_number => $cns, circ_lib => $circ_lib, deleted => 'f'}, {idlist=>1});
1744         }
1745
1746         # ... otherwise, grab the copies ...
1747         my $copies = $e->search_asset_copy(
1748                 [ {call_number => $cns, circ_lib => $circ_lib, deleted => 'f', opac_visible => 't'},
1749                   {flesh => 1, flesh_fields => { acp => [ qw/location status/] } }
1750                 ]
1751         );
1752
1753         # ... and test for location and status visibility
1754         return [ map { ($U->is_true($_->location->opac_visible) && $U->is_true($_->status->opac_visible)) ? ($_->id) : () } @$copies ];
1755 }
1756
1757
1758
1759 1;
1760
1761