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