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 = $arghash->{searches} = {};
 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     if($query) {
 652         # This is the front part of the string before any special tokens were
 653         # parsed OR colon-separated strings that do not denote a class.
 654         # Add this data to the default search class
 655         my $type = $arghash->{default_class} || 'keyword';
 656         $type = ($type eq '-') ? 'keyword' : $type;
 657         $type = ($type !~ /^(title|author|keyword|subject|series)(?:\|\w+)?$/o) ? 'keyword' : $type;
 658         $search->{$type} =  {} unless $search->{$type};
 659         $search->{$type}->{term} =
 660             ($search->{$type}->{term}) ? $search->{$type}->{term} . " $query" : $query;
 661     }
 662
 663     # capture the original limit because the search method alters the limit internally
 664     my $ol = $arghash->{limit};
 665
 666         my $sclient = OpenSRF::Utils::SettingsClient->new;
 667
 668     (my $method = $self->api_name) =~ s/\.query//o;
 669
 670     $method =~ s/multiclass/multiclass.staged/
 671         if $sclient->config_value(apps => 'open-ils.search',
 672             app_settings => 'use_staged_search') =~ /true/i;
 673
 674     $arghash->{preferred_language} = $U->get_org_locale($arghash->{org_unit})
 675         unless $arghash->{preferred_language};
 676
 677         $method = $self->method_lookup($method);
 678     my ($data) = $method->run($arghash, $docache);
 679
 680     $arghash->{limit} = $ol if $ol;
 681     $data->{compiled_search} = $arghash;
 682     $data->{query} = $orig_query;
 683
 684     $logger->info("compiled search is " . OpenSRF::Utils::JSON->perl2JSON($arghash));
 685
 686     return $data;
 687 }
 688
 689 __PACKAGE__->register_method(
 690         method          => 'cat_search_z_style_wrapper',
 691         api_name        => 'open-ils.search.biblio.zstyle',
 692         stream          => 1,
 693         signature       => q/@see open-ils.search.biblio.multiclass/);
 694
 695 __PACKAGE__->register_method(
 696         method          => 'cat_search_z_style_wrapper',
 697         api_name        => 'open-ils.search.biblio.zstyle.staff',
 698         stream          => 1,
 699         signature       => q/@see open-ils.search.biblio.multiclass/);
 700
 701 sub cat_search_z_style_wrapper {
 702         my $self = shift;
 703         my $client = shift;
 704         my $authtoken = shift;
 705         my $args = shift;
 706
 707         my $cstore = OpenSRF::AppSession->connect('open-ils.cstore');
 708
 709         my $ou = $cstore->request(
 710                 'open-ils.cstore.direct.actor.org_unit.search',
 711                 { parent_ou => undef }
 712         )->gather(1);
 713
 714         my $result = { service => 'native-evergreen-catalog', records => [] };
 715         my $searchhash = { limit => $$args{limit}, offset => $$args{offset}, org_unit => $ou->id };
 716
 717         $$searchhash{searches}{title}{term} = $$args{search}{title} if $$args{search}{title};
 718         $$searchhash{searches}{author}{term} = $$args{search}{author} if $$args{search}{author};
 719         $$searchhash{searches}{subject}{term} = $$args{search}{subject} if $$args{search}{subject};
 720         $$searchhash{searches}{keyword}{term} = $$args{search}{keyword} if $$args{search}{keyword};
 721
 722         $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{tcn} if $$args{search}{tcn};
 723         $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{isbn} if $$args{search}{isbn};
 724         $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{issn} if $$args{search}{issn};
 725         $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{publisher} if $$args{search}{publisher};
 726         $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{pubdate} if $$args{search}{pubdate};
 727         $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{item_type} if $$args{search}{item_type};
 728
 729         my $list = the_quest_for_knowledge( $self, $client, $searchhash );
 730
 731         if ($list->{count} > 0) {
 732                 $result->{count} = $list->{count};
 733
 734                 my $records = $cstore->request(
 735                         'open-ils.cstore.direct.biblio.record_entry.search.atomic',
 736                         { id => [ map { ( $_->[0] ) } @{$list->{ids}} ] }
 737                 )->gather(1);
 738
 739                 for my $rec ( @$records ) {
 740
 741                         my $u = OpenILS::Utils::ModsParser->new();
 742                         $u->start_mods_batch( $rec->marc );
 743                         my $mods = $u->finish_mods_batch();
 744
 745                         push @{ $result->{records} }, { mvr => $mods, marcxml => $rec->marc, bibid => $rec->id };
 746
 747                 }
 748
 749         }
 750
 751     $cstore->disconnect();
 752         return $result;
 753 }
 754
 755 # ----------------------------------------------------------------------------
 756 # These are the main OPAC search methods
 757 # ----------------------------------------------------------------------------
 758
 759 __PACKAGE__->register_method(
 760     method    => 'the_quest_for_knowledge',
 761     api_name  => 'open-ils.search.biblio.multiclass',
 762     signature => q/
 763                 Performs a multi class biblio or metabib search
 764                 @param searchhash A search object layed out like so:
 765                         searches : { "$class" : "$value", ...}
 766                         org_unit : The org id to focus the search at
 767                         depth           : The org depth
 768                         limit           : The search limit
 769                         offset  : The search offset
 770                         format  : The MARC format
 771                         sort            : What field to sort the results on [ author | title | pubdate ]
 772                         sort_dir        : What direction do we sort? [ asc | desc ]
 773                 @return An object of the form
 774                         { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }
 775         /
 776 );
 777
 778 __PACKAGE__->register_method(
 779     method    => 'the_quest_for_knowledge',
 780     api_name  => 'open-ils.search.biblio.multiclass.staff',
 781     signature => q/@see open-ils.search.biblio.multiclass/
 782 );
 783 __PACKAGE__->register_method(
 784     method    => 'the_quest_for_knowledge',
 785     api_name  => 'open-ils.search.metabib.multiclass',
 786     signature => q/@see open-ils.search.biblio.multiclass/
 787 );
 788 __PACKAGE__->register_method(
 789     method    => 'the_quest_for_knowledge',
 790     api_name  => 'open-ils.search.metabib.multiclass.staff',
 791     signature => q/@see open-ils.search.biblio.multiclass/
 792 );
 793
 794 sub the_quest_for_knowledge {
 795         my( $self, $conn, $searchhash, $docache ) = @_;
 796
 797         return { count => 0 } unless $searchhash and
 798                 ref $searchhash->{searches} eq 'HASH';
 799
 800         my $method = 'open-ils.storage.biblio.multiclass.search_fts';
 801         my $ismeta = 0;
 802         my @recs;
 803
 804         if($self->api_name =~ /metabib/) {
 805                 $ismeta = 1;
 806                 $method =~ s/biblio/metabib/o;
 807         }
 808
 809
 810         my $offset      = $searchhash->{offset} || 0;
 811         my $limit       = $searchhash->{limit} || 10;
 812         my $end         = $offset + $limit - 1;
 813
 814         # do some simple sanity checking
 815         if(!$searchhash->{searches} or
 816                 ( !grep { /^(?:title|author|subject|series|keyword)/ } keys %{$searchhash->{searches}} ) ) {
 817                 return { count => 0 };
 818         }
 819
 820
 821         my $maxlimit = 5000;
 822         $searchhash->{offset}   = 0;
 823         $searchhash->{limit}            = $maxlimit;
 824
 825         return { count => 0 } if $offset > $maxlimit;
 826
 827         my @search;
 828         push( @search, ($_ => $$searchhash{$_})) for (sort keys %$searchhash);
 829         my $s = OpenSRF::Utils::JSON->perl2JSON(\@search);
 830         my $ckey = $pfx . md5_hex($method . $s);
 831
 832         $logger->info("bib search for: $s");
 833
 834         $searchhash->{limit} -= $offset;
 835
 836
 837     my $trim = 0;
 838         my $result = ($docache) ? search_cache($ckey, $offset, $limit) : undef;
 839
 840         if(!$result) {
 841
 842                 $method .= ".staff" if($self->api_name =~ /staff/);
 843                 $method .= ".atomic";
 844
 845                 for (keys %$searchhash) {
 846                         delete $$searchhash{$_}
 847                                 unless defined $$searchhash{$_};
 848                 }
 849
 850                 $result = $U->storagereq( $method, %$searchhash );
 851         $trim = 1;
 852
 853         } else {
 854                 $docache = 0;
 855         }
 856
 857         return {count => 0} unless ($result && $$result[0]);
 858
 859         @recs = @$result;
 860
 861         my $count = ($ismeta) ? $result->[0]->[3] : $result->[0]->[2];
 862
 863         if($docache) {
 864                 # If we didn't get this data from the cache, put it into the cache
 865                 # then return the correct offset of records
 866                 $logger->debug("putting search cache $ckey\n");
 867                 put_cache($ckey, $count, \@recs);
 868         }
 869
 870     if($trim) {
 871         # if we have the full set of data, trim out
 872         # the requested chunk based on limit and offset
 873         my @t;
 874         for ($offset..$end) {
 875             last unless $recs[$_];
 876             push(@t, $recs[$_]);
 877         }
 878         @recs = @t;
 879     }
 880
 881         return { ids => \@recs, count => $count };
 882 }
 883
 884
 885 __PACKAGE__->register_method(
 886         method          => 'staged_search',
 887         api_name        => 'open-ils.search.biblio.multiclass.staged');
 888 __PACKAGE__->register_method(
 889         method          => 'staged_search',
 890         api_name        => 'open-ils.search.biblio.multiclass.staged.staff',
 891         signature       => q/@see open-ils.search.biblio.multiclass.staged/);
 892 __PACKAGE__->register_method(
 893         method          => 'staged_search',
 894         api_name        => 'open-ils.search.metabib.multiclass.staged',
 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.staff',
 899         signature       => q/@see open-ils.search.biblio.multiclass.staged/);
 900
 901 sub staged_search {
 902         my($self, $conn, $search_hash, $docache) = @_;
 903
 904     my $method = ($self->api_name =~ /metabib/) ?
 905         'open-ils.storage.metabib.multiclass.staged.search_fts':
 906         'open-ils.storage.biblio.multiclass.staged.search_fts';
 907
 908     $method .= '.staff' if $self->api_name =~ /staff$/;
 909     $method .= '.atomic';
 910
 911     return {count => 0} unless (
 912         $search_hash and
 913         $search_hash->{searches} and
 914         scalar( keys %{$search_hash->{searches}} ));
 915
 916     my $search_duration;
 917     my $user_offset = $search_hash->{offset} || 0; # user-specified offset
 918     my $user_limit = $search_hash->{limit} || 10;
 919     $user_offset = ($user_offset >= 0) ? $user_offset : 0;
 920     $user_limit = ($user_limit >= 0) ? $user_limit : 10;
 921
 922
 923     # we're grabbing results on a per-superpage basis, which means the
 924     # limit and offset should coincide with superpage boundaries
 925     $search_hash->{offset} = 0;
 926     $search_hash->{limit} = $superpage_size;
 927
 928     # force a well-known check_limit
 929     $search_hash->{check_limit} = $superpage_size;
 930     # restrict total tested to superpage size * number of superpages
 931     $search_hash->{core_limit} = $superpage_size * $max_superpages;
 932
 933     # Set the configured estimation strategy, defaults to 'inclusion'.
 934         my $estimation_strategy = OpenSRF::Utils::SettingsClient
 935         ->new
 936         ->config_value(
 937             apps => 'open-ils.search', app_settings => 'estimation_strategy'
 938         ) || 'inclusion';
 939         $search_hash->{estimation_strategy} = $estimation_strategy;
 940
 941     # pull any existing results from the cache
 942     my $key = search_cache_key($method, $search_hash);
 943     my $cache_data = $cache->get_cache($key) || {};
 944
 945     # keep retrieving results until we find enough to
 946     # fulfill the user-specified limit and offset
 947     my $all_results = [];
 948     my $page; # current superpage
 949     my $est_hit_count = 0;
 950     my $current_page_summary = {};
 951     my $global_summary = {checked => 0, visible => 0, excluded => 0, deleted => 0, total => 0};
 952     my $is_real_hit_count = 0;
 953
 954     for($page = 0; $page < $max_superpages; $page++) {
 955
 956         my $data = $cache_data->{$page};
 957         my $results;
 958         my $summary;
 959
 960         $logger->debug("staged search: analyzing superpage $page");
 961
 962         if($data) {
 963             # this window of results is already cached
 964             $logger->debug("staged search: found cached results");
 965             $summary = $data->{summary};
 966             $results = $data->{results};
 967
 968         } else {
 969             # retrieve the window of results from the database
 970             $logger->debug("staged search: fetching results from the database");
 971             $search_hash->{skip_check} = $page * $superpage_size;
 972             my $start = time;
 973             $results = $U->storagereq($method, %$search_hash);
 974             $search_duration = time - $start;
 975             $logger->info("staged search: DB call took $search_duration seconds");
 976             $summary = shift(@$results);
 977
 978             unless($summary) {
 979                 $logger->info("search timed out: duration=$search_duration: params=".
 980                     OpenSRF::Utils::JSON->perl2JSON($search_hash));
 981                 return {count => 0};
 982             }
 983
 984             my $hc = $summary->{estimated_hit_count} || $summary->{visible};
 985             if($hc == 0) {
 986                 $logger->info("search returned 0 results: duration=$search_duration: params=".
 987                     OpenSRF::Utils::JSON->perl2JSON($search_hash));
 988             }
 989
 990             # Create backwards-compatible result structures
 991             if($self->api_name =~ /biblio/) {
 992                 $results = [map {[$_->{id}]} @$results];
 993             } else {
 994                 $results = [map {[$_->{id}, $_->{rel}, $_->{record}]} @$results];
 995             }
 996
 997             $results = [grep {defined $_->[0]} @$results];
 998             cache_staged_search_page($key, $page, $summary, $results) if $docache;
 999         }
1000
1001         $current_page_summary = $summary;
1002
1003         # add the new set of results to the set under construction
1004         push(@$all_results, @$results);
1005
1006         my $current_count = scalar(@$all_results);
1007
1008         $est_hit_count = $summary->{estimated_hit_count} || $summary->{visible}
1009             if $page == 0;
1010
1011         $logger->debug("staged search: located $current_count, with estimated hits=".
1012             $summary->{estimated_hit_count}." : visible=".$summary->{visible}.", checked=".$summary->{checked});
1013
1014                 if (defined($summary->{estimated_hit_count})) {
1015                         $global_summary->{checked} += $summary->{checked};
1016                         $global_summary->{visible} += $summary->{visible};
1017                         $global_summary->{excluded} += $summary->{excluded};
1018                         $global_summary->{deleted} += $summary->{deleted};
1019                         $global_summary->{total} = $summary->{total};
1020                 }
1021
1022         # we've found all the possible hits
1023         last if $current_count == $summary->{visible}
1024             and not defined $summary->{estimated_hit_count};
1025
1026         # we've found enough results to satisfy the requested limit/offset
1027         last if $current_count >= ($user_limit + $user_offset);
1028
1029         # we've scanned all possible hits
1030         if($summary->{checked} < $superpage_size) {
1031             $est_hit_count = scalar(@$all_results);
1032             # we have all possible results in hand, so we know the final hit count
1033             $is_real_hit_count = 1;
1034             last;
1035         }
1036     }
1037
1038     my @results = grep {defined $_} @$all_results[$user_offset..($user_offset + $user_limit - 1)];
1039
1040         # refine the estimate if we have more than one superpage
1041         if ($page > 0 and not $is_real_hit_count) {
1042                 if ($global_summary->{checked} >= $global_summary->{total}) {
1043                         $est_hit_count = $global_summary->{visible};
1044                 } else {
1045                         my $updated_hit_count = $U->storagereq(
1046                                 'open-ils.storage.fts_paging_estimate',
1047                                 $global_summary->{checked},
1048                                 $global_summary->{visible},
1049                                 $global_summary->{excluded},
1050                                 $global_summary->{deleted},
1051                                 $global_summary->{total}
1052                         );
1053                         $est_hit_count = $updated_hit_count->{$estimation_strategy};
1054                 }
1055         }
1056
1057     return {
1058         count => $est_hit_count,
1059         core_limit => $search_hash->{core_limit},
1060         superpage_size => $search_hash->{check_limit},
1061         superpage_summary => $current_page_summary,
1062         ids => \@results
1063     };
1064 }
1065
1066 # creates a unique token to represent the query in the cache
1067 sub search_cache_key {
1068     my $method = shift;
1069     my $search_hash = shift;
1070         my @sorted;
1071     for my $key (sort keys %$search_hash) {
1072             push(@sorted, ($key => $$search_hash{$key}))
1073             unless $key eq 'limit' or
1074                 $key eq 'offset' or
1075                 $key eq 'skip_check';
1076     }
1077         my $s = OpenSRF::Utils::JSON->perl2JSON(\@sorted);
1078         return $pfx . md5_hex($method . $s);
1079 }
1080
1081 sub cache_staged_search_page {
1082     # puts this set of results into the cache
1083     my($key, $page, $summary, $results) = @_;
1084     my $data = $cache->get_cache($key);
1085     $data ||= {};
1086     $data->{$page} = {
1087         summary => $summary,
1088         results => $results
1089     };
1090
1091     $logger->info("staged search: cached with key=$key, superpage=$page, estimated=".
1092         $summary->{estimated_hit_count}.", visible=".$summary->{visible});
1093
1094     $cache->put_cache($key, $data, $cache_timeout);
1095 }
1096
1097 sub search_cache {
1098
1099         my $key         = shift;
1100         my $offset      = shift;
1101         my $limit       = shift;
1102         my $start       = $offset;
1103         my $end         = $offset + $limit - 1;
1104
1105         $logger->debug("searching cache for $key : $start..$end\n");
1106
1107         return undef unless $cache;
1108         my $data = $cache->get_cache($key);
1109
1110         return undef unless $data;
1111
1112         my $count = $data->[0];
1113         $data = $data->[1];
1114
1115         return undef unless $offset < $count;
1116
1117         my @result;
1118         for( my $i = $offset; $i <= $end; $i++ ) {
1119                 last unless my $d = $$data[$i];
1120                 push( @result, $d );
1121         }
1122
1123         $logger->debug("search_cache found ".scalar(@result)." items for count=$count, start=$start, end=$end");
1124
1125         return \@result;
1126 }
1127
1128
1129 sub put_cache {
1130         my( $key, $count, $data ) = @_;
1131         return undef unless $cache;
1132         $logger->debug("search_cache putting ".
1133                 scalar(@$data)." items at key $key with timeout $cache_timeout");
1134         $cache->put_cache($key, [ $count, $data ], $cache_timeout);
1135 }
1136
1137
1138
1139
1140
1141
1142 __PACKAGE__->register_method(
1143         method  => "biblio_mrid_to_modsbatch_batch",
1144         api_name        => "open-ils.search.biblio.metarecord.mods_slim.batch.retrieve");
1145
1146 sub biblio_mrid_to_modsbatch_batch {
1147         my( $self, $client, $mrids) = @_;
1148         warn "Performing mrid_to_modsbatch_batch...";
1149         my @mods;
1150         my $method = $self->method_lookup("open-ils.search.biblio.metarecord.mods_slim.retrieve");
1151         for my $id (@$mrids) {
1152                 next unless defined $id;
1153                 my ($m) = $method->run($id);
1154                 push @mods, $m;
1155         }
1156         return \@mods;
1157 }
1158
1159
1160 __PACKAGE__->register_method(
1161         method  => "biblio_mrid_to_modsbatch",
1162         api_name        => "open-ils.search.biblio.metarecord.mods_slim.retrieve",
1163         notes           => <<"  NOTES");
1164         Returns the mvr associated with a given metarecod. If none exists,
1165         it is created.
1166         NOTES
1167
1168 __PACKAGE__->register_method(
1169         method  => "biblio_mrid_to_modsbatch",
1170         api_name        => "open-ils.search.biblio.metarecord.mods_slim.retrieve.staff",
1171         notes           => <<"  NOTES");
1172         Returns the mvr associated with a given metarecod. If none exists,
1173         it is created.
1174         NOTES
1175
1176 sub biblio_mrid_to_modsbatch {
1177         my( $self, $client, $mrid, $args) = @_;
1178
1179         warn "Grabbing mvr for $mrid\n";
1180
1181         my ($mr, $evt) = _grab_metarecord($mrid);
1182         return $evt unless $mr;
1183
1184         my $mvr = biblio_mrid_check_mvr($self, $client, $mr);
1185         $mvr = biblio_mrid_make_modsbatch( $self, $client, $mr ) unless $mvr;
1186
1187         return $mvr unless ref($args);
1188
1189         # Here we find the lead record appropriate for the given filters
1190         # and use that for the title and author of the metarecord
1191         my $format      = $$args{format};
1192         my $org         = $$args{org};
1193         my $depth       = $$args{depth};
1194
1195         return $mvr unless $format or $org or $depth;
1196
1197         my $method = "open-ils.storage.ordered.metabib.metarecord.records";
1198         $method = "$method.staff" if $self->api_name =~ /staff/o;
1199
1200         my $rec = $U->storagereq($method, $format, $org, $depth, 1);
1201
1202         if( my $mods = $U->record_to_mvr($rec) ) {
1203
1204                 $mvr->title($mods->title);
1205                 $mvr->title($mods->author);
1206                 $logger->debug("mods_slim updating title and ".
1207                         "author in mvr with ".$mods->title." : ".$mods->author);
1208         }
1209
1210         return $mvr;
1211 }
1212
1213 # converts a metarecord to an mvr
1214 sub _mr_to_mvr {
1215         my $mr = shift;
1216         my $perl = OpenSRF::Utils::JSON->JSON2perl($mr->mods());
1217         return Fieldmapper::metabib::virtual_record->new($perl);
1218 }
1219
1220 # checks to see if a metarecord has mods, if so returns true;
1221
1222 __PACKAGE__->register_method(
1223         method  => "biblio_mrid_check_mvr",
1224         api_name        => "open-ils.search.biblio.metarecord.mods_slim.check",
1225         notes           => <<"  NOTES");
1226         Takes a metarecord ID or a metarecord object and returns true
1227         if the metarecord already has an mvr associated with it.
1228         NOTES
1229
1230 sub biblio_mrid_check_mvr {
1231         my( $self, $client, $mrid ) = @_;
1232         my $mr;
1233
1234         my $evt;
1235         if(ref($mrid)) { $mr = $mrid; }
1236         else { ($mr, $evt) = _grab_metarecord($mrid); }
1237         return $evt if $evt;
1238
1239         warn "Checking mvr for mr " . $mr->id . "\n";
1240
1241         return _mr_to_mvr($mr) if $mr->mods();
1242         return undef;
1243 }
1244
1245 sub _grab_metarecord {
1246         my $mrid = shift;
1247         #my $e = OpenILS::Utils::Editor->new;
1248         my $e = new_editor();
1249         my $mr = $e->retrieve_metabib_metarecord($mrid) or return ( undef, $e->event );
1250         return ($mr);
1251 }
1252
1253
1254 __PACKAGE__->register_method(
1255         method  => "biblio_mrid_make_modsbatch",
1256         api_name        => "open-ils.search.biblio.metarecord.mods_slim.create",
1257         notes           => <<"  NOTES");
1258         Takes either a metarecord ID or a metarecord object.
1259         Forces the creations of an mvr for the given metarecord.
1260         The created mvr is returned.
1261         NOTES
1262
1263 sub biblio_mrid_make_modsbatch {
1264         my( $self, $client, $mrid ) = @_;
1265
1266         #my $e = OpenILS::Utils::Editor->new;
1267         my $e = new_editor();
1268
1269         my $mr;
1270         if( ref($mrid) ) {
1271                 $mr = $mrid;
1272                 $mrid = $mr->id;
1273         } else {
1274                 $mr = $e->retrieve_metabib_metarecord($mrid)
1275                         or return $e->event;
1276         }
1277
1278         my $masterid = $mr->master_record;
1279         $logger->info("creating new mods batch for metarecord=$mrid, master record=$masterid");
1280
1281         my $ids = $U->storagereq(
1282                 'open-ils.storage.ordered.metabib.metarecord.records.staff.atomic', $mrid);
1283         return undef unless @$ids;
1284
1285         my $master = $e->retrieve_biblio_record_entry($masterid)
1286                 or return $e->event;
1287
1288         # start the mods batch
1289         my $u = OpenILS::Utils::ModsParser->new();
1290         $u->start_mods_batch( $master->marc );
1291
1292         # grab all of the sub-records and shove them into the batch
1293         my @ids = grep { $_ ne $masterid } @$ids;
1294         #my $subrecs = (@ids) ? $e->batch_retrieve_biblio_record_entry(\@ids) : [];
1295
1296         my $subrecs = [];
1297         if(@$ids) {
1298                 for my $i (@$ids) {
1299                         my $r = $e->retrieve_biblio_record_entry($i);
1300                         push( @$subrecs, $r ) if $r;
1301                 }
1302         }
1303
1304         for(@$subrecs) {
1305                 $logger->debug("adding record ".$_->id." to mods batch for metarecord=$mrid");
1306                 $u->push_mods_batch( $_->marc ) if $_->marc;
1307         }
1308
1309
1310         # finish up and send to the client
1311         my $mods = $u->finish_mods_batch();
1312         $mods->doc_id($mrid);
1313         $client->respond_complete($mods);
1314
1315
1316         # now update the mods string in the db
1317         my $string = OpenSRF::Utils::JSON->perl2JSON($mods->decast);
1318         $mr->mods($string);
1319
1320         #$e = OpenILS::Utils::Editor->new(xact => 1);
1321         $e = new_editor(xact => 1);
1322         $e->update_metabib_metarecord($mr)
1323                 or $logger->error("Error setting mods text on metarecord $mrid : " . Dumper($e->event));
1324         $e->finish;
1325
1326         return undef;
1327 }
1328
1329
1330
1331
1332 # converts a mr id into a list of record ids
1333
1334 __PACKAGE__->register_method(
1335         method  => "biblio_mrid_to_record_ids",
1336         api_name        => "open-ils.search.biblio.metarecord_to_records",
1337 );
1338
1339 __PACKAGE__->register_method(
1340         method  => "biblio_mrid_to_record_ids",
1341         api_name        => "open-ils.search.biblio.metarecord_to_records.staff",
1342 );
1343
1344 sub biblio_mrid_to_record_ids {
1345         my( $self, $client, $mrid, $args ) = @_;
1346
1347         my $format      = $$args{format};
1348         my $org         = $$args{org};
1349         my $depth       = $$args{depth};
1350
1351         my $method = "open-ils.storage.ordered.metabib.metarecord.records.atomic";
1352         $method =~ s/atomic/staff\.atomic/o if $self->api_name =~ /staff/o;
1353         my $recs = $U->storagereq($method, $mrid, $format, $org, $depth);
1354
1355         return { count => scalar(@$recs), ids => $recs };
1356 }
1357
1358
1359 __PACKAGE__->register_method(
1360         method  => "biblio_record_to_marc_html",
1361         api_name        => "open-ils.search.biblio.record.html" );
1362
1363 __PACKAGE__->register_method(
1364         method  => "biblio_record_to_marc_html",
1365         api_name        => "open-ils.search.authority.to_html" );
1366
1367 my $parser = XML::LibXML->new();
1368 my $xslt = XML::LibXSLT->new();
1369 my $marc_sheet;
1370 my $slim_marc_sheet;
1371 my $settings_client = OpenSRF::Utils::SettingsClient->new();
1372
1373 sub biblio_record_to_marc_html {
1374         my($self, $client, $recordid, $slim, $marcxml) = @_;
1375
1376     my $sheet;
1377         my $dir = $settings_client->config_value("dirs", "xsl");
1378
1379     if($slim) {
1380         unless($slim_marc_sheet) {
1381                     my $xsl = $settings_client->config_value(
1382                             "apps", "open-ils.search", "app_settings", 'marc_html_xsl_slim');
1383             if($xsl) {
1384                         $xsl = $parser->parse_file("$dir/$xsl");
1385                         $slim_marc_sheet = $xslt->parse_stylesheet($xsl);
1386             }
1387         }
1388         $sheet = $slim_marc_sheet;
1389     }
1390
1391     unless($sheet) {
1392         unless($marc_sheet) {
1393             my $xsl_key = ($slim) ? 'marc_html_xsl_slim' : 'marc_html_xsl';
1394                     my $xsl = $settings_client->config_value(
1395                             "apps", "open-ils.search", "app_settings", 'marc_html_xsl');
1396                     $xsl = $parser->parse_file("$dir/$xsl");
1397                     $marc_sheet = $xslt->parse_stylesheet($xsl);
1398         }
1399         $sheet = $marc_sheet;
1400     }
1401
1402     my $record;
1403     unless($marcxml) {
1404         my $e = new_editor();
1405         if($self->api_name =~ /authority/) {
1406             $record = $e->retrieve_authority_record_entry($recordid)
1407                 or return $e->event;
1408         } else {
1409             $record = $e->retrieve_biblio_record_entry($recordid)
1410                 or return $e->event;
1411         }
1412         $marcxml = $record->marc;
1413     }
1414
1415         my $xmldoc = $parser->parse_string($marcxml);
1416         my $html = $sheet->transform($xmldoc);
1417         return $html->documentElement->toString();
1418 }
1419
1420
1421
1422 __PACKAGE__->register_method(
1423         method  => "retrieve_all_copy_statuses",
1424         api_name        => "open-ils.search.config.copy_status.retrieve.all" );
1425
1426 sub retrieve_all_copy_statuses {
1427         my( $self, $client ) = @_;
1428         return new_editor()->retrieve_all_config_copy_status();
1429 }
1430
1431
1432 __PACKAGE__->register_method(
1433         method  => "copy_counts_per_org",
1434         api_name        => "open-ils.search.biblio.copy_counts.retrieve");
1435
1436 __PACKAGE__->register_method(
1437         method  => "copy_counts_per_org",
1438         api_name        => "open-ils.search.biblio.copy_counts.retrieve.staff");
1439
1440 sub copy_counts_per_org {
1441         my( $self, $client, $record_id ) = @_;
1442
1443         warn "Retreiveing copy copy counts for record $record_id and method " . $self->api_name . "\n";
1444
1445         my $method = "open-ils.storage.biblio.record_entry.global_copy_count.atomic";
1446         if($self->api_name =~ /staff/) { $method =~ s/atomic/staff\.atomic/; }
1447
1448         my $counts = $apputils->simple_scalar_request(
1449                 "open-ils.storage", $method, $record_id );
1450
1451         $counts = [ sort {$a->[0] <=> $b->[0]} @$counts ];
1452         return $counts;
1453 }
1454
1455
1456 __PACKAGE__->register_method(
1457         method          => "copy_count_summary",
1458         api_name        => "open-ils.search.biblio.copy_counts.summary.retrieve",
1459         notes           => <<"  NOTES");
1460         returns an array of these:
1461                 [ org_id, callnumber_label, <status1_count>, <status2_count>,...]
1462                 where statusx is a copy status name.  the statuses are sorted
1463                 by id.
1464         NOTES
1465
1466 sub copy_count_summary {
1467         my( $self, $client, $rid, $org, $depth ) = @_;
1468         $org ||= 1;
1469         $depth ||= 0;
1470     my $data = $U->storagereq(
1471                 'open-ils.storage.biblio.record_entry.status_copy_count.atomic', $rid, $org, $depth );
1472
1473     return [ sort { $a->[1] cmp $b->[1] } @$data ];
1474 }
1475
1476 __PACKAGE__->register_method(
1477         method          => "copy_location_count_summary",
1478         api_name        => "open-ils.search.biblio.copy_location_counts.summary.retrieve",
1479         notes           => <<"  NOTES");
1480         returns an array of these:
1481                 [ org_id, callnumber_label, copy_location, <status1_count>, <status2_count>,...]
1482                 where statusx is a copy status name.  the statuses are sorted
1483                 by id.
1484         NOTES
1485
1486 sub copy_location_count_summary {
1487         my( $self, $client, $rid, $org, $depth ) = @_;
1488         $org ||= 1;
1489         $depth ||= 0;
1490     my $data = $U->storagereq(
1491                 'open-ils.storage.biblio.record_entry.status_copy_location_count.atomic', $rid, $org, $depth );
1492
1493     return [ sort { $a->[1] cmp $b->[1] || $a->[2] cmp $b->[2] } @$data ];
1494 }
1495
1496 __PACKAGE__->register_method(
1497         method          => "copy_count_location_summary",
1498         api_name        => "open-ils.search.biblio.copy_counts.location.summary.retrieve",
1499         notes           => <<"  NOTES");
1500         returns an array of these:
1501                 [ org_id, callnumber_label, <status1_count>, <status2_count>,...]
1502                 where statusx is a copy status name.  the statuses are sorted
1503                 by id.
1504         NOTES
1505
1506 sub copy_count_location_summary {
1507         my( $self, $client, $rid, $org, $depth ) = @_;
1508         $org ||= 1;
1509         $depth ||= 0;
1510     my $data = $U->storagereq(
1511         'open-ils.storage.biblio.record_entry.status_copy_location_count.atomic', $rid, $org, $depth );
1512     return [ sort { $a->[1] cmp $b->[1] } @$data ];
1513 }
1514
1515
1516 __PACKAGE__->register_method(
1517         method          => "marc_search",
1518         api_name        => "open-ils.search.biblio.marc.staff");
1519
1520 __PACKAGE__->register_method(
1521         method          => "marc_search",
1522         api_name        => "open-ils.search.biblio.marc",
1523         notes           => <<"  NOTES");
1524                 Example:
1525                 open-ils.storage.biblio.full_rec.multi_search.atomic
1526                 { "searches": [{"term":"harry","restrict": [{"tag":245,"subfield":"a"}]}], "org_unit": 1,
1527         "limit":5,"sort":"author","item_type":"g"}
1528         NOTES
1529
1530 sub marc_search {
1531         my( $self, $conn, $args, $limit, $offset ) = @_;
1532
1533         my $method = 'open-ils.storage.biblio.full_rec.multi_search';
1534         $method .= ".staff" if $self->api_name =~ /staff/;
1535         $method .= ".atomic";
1536
1537         $limit ||= 10;
1538         $offset ||= 0;
1539
1540         my @search;
1541         push( @search, ($_ => $$args{$_}) ) for (sort keys %$args);
1542         my $ckey = $pfx . md5_hex($method . OpenSRF::Utils::JSON->perl2JSON(\@search));
1543
1544         my $recs = search_cache($ckey, $offset, $limit);
1545
1546         if(!$recs) {
1547                 $recs = $U->storagereq($method, %$args) || [];
1548                 if( $recs ) {
1549                         put_cache($ckey, scalar(@$recs), $recs);
1550                         $recs = [ @$recs[$offset..($offset + ($limit - 1))] ];
1551                 } else {
1552                         $recs = [];
1553                 }
1554         }
1555
1556         my $count = 0;
1557         $count = $recs->[0]->[2] if $recs->[0] and $recs->[0]->[2];
1558         my @recs = map { $_->[0] } @$recs;
1559
1560         return { ids => \@recs, count => $count };
1561 }
1562
1563
1564 __PACKAGE__->register_method(
1565         method  => "biblio_search_isbn",
1566         api_name        => "open-ils.search.biblio.isbn",
1567 );
1568
1569 sub biblio_search_isbn {
1570         my( $self, $client, $isbn ) = @_;
1571         $logger->debug("Searching ISBN $isbn");
1572         my $e = new_editor();
1573         my $recs = $U->storagereq(
1574                 'open-ils.storage.id_list.biblio.record_entry.search.isbn.atomic', $isbn );
1575         return { ids => $recs, count => scalar(@$recs) };
1576 }
1577
1578 __PACKAGE__->register_method(
1579         method  => "biblio_search_isbn_batch",
1580         api_name        => "open-ils.search.biblio.isbn_list",
1581 );
1582
1583 sub biblio_search_isbn_batch {
1584         my( $self, $client, $isbn_list ) = @_;
1585         $logger->debug("Searching ISBNs @$isbn_list");
1586         my @recs = (); my %rec_set = ();
1587         foreach my $isbn ( @$isbn_list ) {
1588                 foreach my $rec ( @{ $U->storagereq(
1589                         'open-ils.storage.id_list.biblio.record_entry.search.isbn.atomic', $isbn )
1590                 } ) {
1591                         if (! $rec_set{ $rec }) {
1592                                 $rec_set{ $rec } = 1;
1593                                 push @recs, $rec;
1594                         }
1595                 }
1596         }
1597         return { ids => \@recs, count => scalar(@recs) };
1598 }
1599
1600 __PACKAGE__->register_method(
1601         method  => "biblio_search_issn",
1602         api_name        => "open-ils.search.biblio.issn",
1603 );
1604
1605 sub biblio_search_issn {
1606         my( $self, $client, $issn ) = @_;
1607         $logger->debug("Searching ISSN $issn");
1608         my $e = new_editor();
1609         $issn =~ s/-/ /g;
1610         my $recs = $U->storagereq(
1611                 'open-ils.storage.id_list.biblio.record_entry.search.issn.atomic', $issn );
1612         return { ids => $recs, count => scalar(@$recs) };
1613 }
1614
1615
1616
1617
1618 __PACKAGE__->register_method(
1619         method  => "fetch_mods_by_copy",
1620         api_name        => "open-ils.search.biblio.mods_from_copy",
1621 );
1622
1623 sub fetch_mods_by_copy {
1624         my( $self, $client, $copyid ) = @_;
1625         my ($record, $evt) = $apputils->fetch_record_by_copy( $copyid );
1626         return $evt if $evt;
1627         return OpenILS::Event->new('ITEM_NOT_CATALOGED') unless $record->marc;
1628         return $apputils->record_to_mvr($record);
1629 }
1630
1631
1632
1633 # -------------------------------------------------------------------------------------
1634
1635 __PACKAGE__->register_method(
1636         method  => "cn_browse",
1637         api_name        => "open-ils.search.callnumber.browse.target",
1638         notes           => "Starts a callnumber browse"
1639         );
1640
1641 __PACKAGE__->register_method(
1642         method  => "cn_browse",
1643         api_name        => "open-ils.search.callnumber.browse.page_up",
1644         notes           => "Returns the previous page of callnumbers",
1645         );
1646
1647 __PACKAGE__->register_method(
1648         method  => "cn_browse",
1649         api_name        => "open-ils.search.callnumber.browse.page_down",
1650         notes           => "Returns the next page of callnumbers",
1651         );
1652
1653
1654 # RETURNS array of arrays like so: label, owning_lib, record, id
1655 sub cn_browse {
1656         my( $self, $client, @params ) = @_;
1657         my $method;
1658
1659         $method = 'open-ils.storage.asset.call_number.browse.target.atomic'
1660                 if( $self->api_name =~ /target/ );
1661         $method = 'open-ils.storage.asset.call_number.browse.page_up.atomic'
1662                 if( $self->api_name =~ /page_up/ );
1663         $method = 'open-ils.storage.asset.call_number.browse.page_down.atomic'
1664                 if( $self->api_name =~ /page_down/ );
1665
1666         return $apputils->simplereq( 'open-ils.storage', $method, @params );
1667 }
1668 # -------------------------------------------------------------------------------------
1669
1670 __PACKAGE__->register_method(
1671         method => "fetch_cn",
1672     authoritative => 1,
1673         api_name => "open-ils.search.callnumber.retrieve",
1674         notes           => "retrieves a callnumber based on ID",
1675         );
1676
1677 sub fetch_cn {
1678         my( $self, $client, $id ) = @_;
1679         my( $cn, $evt ) = $apputils->fetch_callnumber( $id );
1680         return $evt if $evt;
1681         return $cn;
1682 }
1683
1684 __PACKAGE__->register_method (
1685         method          => "fetch_copy_by_cn",
1686         api_name                => 'open-ils.search.copies_by_call_number.retrieve',
1687         signature       => q/
1688                 Returns an array of copy id's by callnumber id
1689                 @param cnid The callnumber id
1690                 @return An array of copy ids
1691         /
1692 );
1693
1694 sub fetch_copy_by_cn {
1695         my( $self, $conn, $cnid ) = @_;
1696         return $U->cstorereq(
1697                 'open-ils.cstore.direct.asset.copy.id_list.atomic',
1698                 { call_number => $cnid, deleted => 'f' } );
1699 }
1700
1701 __PACKAGE__->register_method (
1702         method          => 'fetch_cn_by_info',
1703         api_name                => 'open-ils.search.call_number.retrieve_by_info',
1704         signature       => q/
1705                 @param label The callnumber label
1706                 @param record The record the cn is attached to
1707                 @param org The owning library of the cn
1708                 @return The callnumber object
1709         /
1710 );
1711
1712
1713 sub fetch_cn_by_info {
1714         my( $self, $conn, $label, $record, $org ) = @_;
1715         return $U->cstorereq(
1716                 'open-ils.cstore.direct.asset.call_number.search',
1717                 { label => $label, record => $record, owning_lib => $org, deleted => 'f' });
1718 }
1719
1720
1721
1722
1723
1724 __PACKAGE__->register_method (
1725         method => 'bib_extras',
1726         api_name => 'open-ils.search.biblio.lit_form_map.retrieve.all');
1727 __PACKAGE__->register_method (
1728         method => 'bib_extras',
1729         api_name => 'open-ils.search.biblio.item_form_map.retrieve.all');
1730 __PACKAGE__->register_method (
1731         method => 'bib_extras',
1732         api_name => 'open-ils.search.biblio.item_type_map.retrieve.all');
1733 __PACKAGE__->register_method (
1734         method => 'bib_extras',
1735         api_name => 'open-ils.search.biblio.bib_level_map.retrieve.all');
1736 __PACKAGE__->register_method (
1737         method => 'bib_extras',
1738         api_name => 'open-ils.search.biblio.audience_map.retrieve.all');
1739
1740 sub bib_extras {
1741         my $self = shift;
1742
1743         my $e = new_editor();
1744
1745         return $e->retrieve_all_config_lit_form_map()
1746                 if( $self->api_name =~ /lit_form/ );
1747
1748         return $e->retrieve_all_config_item_form_map()
1749                 if( $self->api_name =~ /item_form_map/ );
1750
1751         return $e->retrieve_all_config_item_type_map()
1752                 if( $self->api_name =~ /item_type_map/ );
1753
1754         return $e->retrieve_all_config_bib_level_map()
1755                 if( $self->api_name =~ /bib_level_map/ );
1756
1757         return $e->retrieve_all_config_audience_map()
1758                 if( $self->api_name =~ /audience_map/ );
1759
1760         return [];
1761 }
1762
1763
1764
1765 __PACKAGE__->register_method(
1766         method  => 'fetch_slim_record',
1767         api_name        => 'open-ils.search.biblio.record_entry.slim.retrieve',
1768         signature=> q/
1769                 Returns a biblio.record_entry without the attached marcxml
1770         /
1771 );
1772
1773 sub fetch_slim_record {
1774         my( $self, $conn, $ids ) = @_;
1775
1776         #my $editor = OpenILS::Utils::Editor->new;
1777         my $editor = new_editor();
1778         my @res;
1779         for( @$ids ) {
1780                 return $editor->event unless
1781                         my $r = $editor->retrieve_biblio_record_entry($_);
1782                 $r->clear_marc;
1783                 push(@res, $r);
1784         }
1785         return \@res;
1786 }
1787
1788
1789
1790 __PACKAGE__->register_method(
1791         method => 'rec_to_mr_rec_descriptors',
1792         api_name        => 'open-ils.search.metabib.record_to_descriptors',
1793         signature       => q/
1794                 specialized method...
1795                 Given a biblio record id or a metarecord id,
1796                 this returns a list of metabib.record_descriptor
1797                 objects that live within the same metarecord
1798                 @param args Object of args including:
1799         /
1800 );
1801
1802 sub rec_to_mr_rec_descriptors {
1803         my( $self, $conn, $args ) = @_;
1804
1805         my $rec = $$args{record};
1806         my $mrec        = $$args{metarecord};
1807         my $item_forms = $$args{item_forms};
1808         my $item_types  = $$args{item_types};
1809         my $item_lang   = $$args{item_lang};
1810
1811         my $e = new_editor();
1812         my $recs;
1813
1814         if( !$mrec ) {
1815                 my $map = $e->search_metabib_metarecord_source_map({source => $rec});
1816                 return $e->event unless @$map;
1817                 $mrec = $$map[0]->metarecord;
1818         }
1819
1820         $recs = $e->search_metabib_metarecord_source_map({metarecord => $mrec});
1821         return $e->event unless @$recs;
1822
1823         my @recs = map { $_->source } @$recs;
1824         my $search = { record => \@recs };
1825         $search->{item_form} = $item_forms if $item_forms and @$item_forms;
1826         $search->{item_type} = $item_types if $item_types and @$item_types;
1827         $search->{item_lang} = $item_lang if $item_lang;
1828
1829         my $desc = $e->search_metabib_record_descriptor($search);
1830
1831         return { metarecord => $mrec, descriptors => $desc };
1832 }
1833
1834
1835
1836
1837 __PACKAGE__->register_method(
1838         method => 'copies_created_on',
1839 );
1840
1841
1842 sub copies_created_on {
1843         my( $self, $conn, $auth, $org, $date ) = @_;
1844         my $e = new_editor(authtoken=>$auth);
1845         return $e->event unless $e->checkauth;
1846 }
1847
1848
1849 __PACKAGE__->register_method(
1850         method => 'fetch_age_protect',
1851         api_name => 'open-ils.search.copy.age_protect.retrieve.all',
1852 );
1853
1854 sub fetch_age_protect {
1855         return new_editor()->retrieve_all_config_rule_age_hold_protect();
1856 }
1857
1858
1859 __PACKAGE__->register_method(
1860         method => 'copies_by_cn_label',
1861         api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label',
1862 );
1863
1864 __PACKAGE__->register_method(
1865         method => 'copies_by_cn_label',
1866         api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label.staff',
1867 );
1868
1869 sub copies_by_cn_label {
1870         my( $self, $conn, $record, $label, $circ_lib ) = @_;
1871         my $e = new_editor();
1872         my $cns = $e->search_asset_call_number({record => $record, label => $label, deleted => 'f'}, {idlist=>1});
1873         return [] unless @$cns;
1874
1875         # show all non-deleted copies in the staff client ...
1876         if ($self->api_name =~ /staff$/o) {
1877                 return $e->search_asset_copy({call_number => $cns, circ_lib => $circ_lib, deleted => 'f'}, {idlist=>1});
1878         }
1879
1880         # ... otherwise, grab the copies ...
1881         my $copies = $e->search_asset_copy(
1882                 [ {call_number => $cns, circ_lib => $circ_lib, deleted => 'f', opac_visible => 't'},
1883                   {flesh => 1, flesh_fields => { acp => [ qw/location status/] } }
1884                 ]
1885         );
1886
1887         # ... and test for location and status visibility
1888         return [ map { ($U->is_true($_->location->opac_visible) && $U->is_true($_->status->opac_visible)) ? ($_->id) : () } @$copies ];
1889 }
1890
1891
1892
1893 1;
1894
1895