Open-ILS/src/perlmods/lib/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();  # FIXME: we really need a new parser for each object?
  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     signature => {
  94         desc   => "Provide ID, we provide the MODS object with copy count.  "
  95                 . "Note: this method does NOT take an array of IDs like mods_slim.retrieve",    # FIXME: do it here too
  96         params => [
  97             { desc => 'Record ID', type => 'number' }
  98         ],
  99         return => {
 100             desc => 'MODS object', type => 'object'
 101         }
 102     }
 103 );
 104
 105 # converts a record into a mods object with copy counts attached
 106 sub record_id_to_mods {
 107
 108     my( $self, $client, $org_id, $id ) = @_;
 109
 110     my $mods_list = _records_to_mods( $id );
 111     my $mods_obj  = $mods_list->[0];
 112     my $cmethod   = $self->method_lookup("open-ils.search.biblio.record.copy_count");
 113     my ($count)   = $cmethod->run($org_id, $id);
 114     $mods_obj->copy_count($count);
 115
 116     return $mods_obj;
 117 }
 118
 119
 120
 121 __PACKAGE__->register_method(
 122     method        => "record_id_to_mods_slim",
 123     api_name      => "open-ils.search.biblio.record.mods_slim.retrieve",
 124     argc          => 1,
 125     authoritative => 1,
 126     signature     => {
 127         desc   => "Provide ID(s), we provide the MODS",
 128         params => [
 129             { desc => 'Record ID or array of IDs' }
 130         ],
 131         return => {
 132             desc => 'MODS object(s), event on error'
 133         }
 134     }
 135 );
 136
 137 # converts a record into a mods object with NO copy counts attached
 138 sub record_id_to_mods_slim {
 139     my( $self, $client, $id ) = @_;
 140     return undef unless defined $id;
 141
 142     if(ref($id) and ref($id) == 'ARRAY') {
 143         return _records_to_mods( @$id );
 144     }
 145     my $mods_list = _records_to_mods( $id );
 146     my $mods_obj  = $mods_list->[0];
 147     return OpenILS::Event->new('BIBLIO_RECORD_ENTRY_NOT_FOUND') unless $mods_obj;
 148     return $mods_obj;
 149 }
 150
 151
 152
 153 __PACKAGE__->register_method(
 154     method   => "record_id_to_mods_slim_batch",
 155     api_name => "open-ils.search.biblio.record.mods_slim.batch.retrieve",
 156     stream   => 1
 157 );
 158 sub record_id_to_mods_slim_batch {
 159     my($self, $conn, $id_list) = @_;
 160     $conn->respond(_records_to_mods($_)->[0]) for @$id_list;
 161     return undef;
 162 }
 163
 164
 165 # Returns the number of copies attached to a record based on org location
 166 __PACKAGE__->register_method(
 167     method   => "record_id_to_copy_count",
 168     api_name => "open-ils.search.biblio.record.copy_count",
 169     signature => {
 170         desc => q/Returns a copy summary for the given record for the context org
 171             unit and all ancestor org units/,
 172         params => [
 173             {desc => 'Context org unit id', type => 'number'},
 174             {desc => 'Record ID', type => 'number'}
 175         ],
 176         return => {
 177             desc => q/summary object per org unit in the set, where the set
 178                 includes the context org unit and all parent org units.
 179                 Object includes the keys "transcendant", "count", "org_unit", "depth",
 180                 "unshadow", "available".  Each is a count, except "org_unit" which is
 181                 the context org unit and "depth" which is the depth of the context org unit
 182             /,
 183             type => 'array'
 184         }
 185     }
 186 );
 187
 188 __PACKAGE__->register_method(
 189     method        => "record_id_to_copy_count",
 190     api_name      => "open-ils.search.biblio.record.copy_count.staff",
 191     authoritative => 1,
 192     signature => {
 193         desc => q/Returns a copy summary for the given record for the context org
 194             unit and all ancestor org units/,
 195         params => [
 196             {desc => 'Context org unit id', type => 'number'},
 197             {desc => 'Record ID', type => 'number'}
 198         ],
 199         return => {
 200             desc => q/summary object per org unit in the set, where the set
 201                 includes the context org unit and all parent org units.
 202                 Object includes the keys "transcendant", "count", "org_unit", "depth",
 203                 "unshadow", "available".  Each is a count, except "org_unit" which is
 204                 the context org unit and "depth" which is the depth of the context org unit
 205             /,
 206             type => 'array'
 207         }
 208     }
 209 );
 210
 211 __PACKAGE__->register_method(
 212     method   => "record_id_to_copy_count",
 213     api_name => "open-ils.search.biblio.metarecord.copy_count",
 214     signature => {
 215         desc => q/Returns a copy summary for the given record for the context org
 216             unit and all ancestor org units/,
 217         params => [
 218             {desc => 'Context org unit id', type => 'number'},
 219             {desc => 'Record ID', type => 'number'}
 220         ],
 221         return => {
 222             desc => q/summary object per org unit in the set, where the set
 223                 includes the context org unit and all parent org units.
 224                 Object includes the keys "transcendant", "count", "org_unit", "depth",
 225                 "unshadow", "available".  Each is a count, except "org_unit" which is
 226                 the context org unit and "depth" which is the depth of the context org unit
 227             /,
 228             type => 'array'
 229         }
 230     }
 231 );
 232
 233 __PACKAGE__->register_method(
 234     method   => "record_id_to_copy_count",
 235     api_name => "open-ils.search.biblio.metarecord.copy_count.staff",
 236     signature => {
 237         desc => q/Returns a copy summary for the given record for the context org
 238             unit and all ancestor org units/,
 239         params => [
 240             {desc => 'Context org unit id', type => 'number'},
 241             {desc => 'Record ID', type => 'number'}
 242         ],
 243         return => {
 244             desc => q/summary object per org unit in the set, where the set
 245                 includes the context org unit and all parent org units.
 246                 Object includes the keys "transcendant", "count", "org_unit", "depth",
 247                 "unshadow", "available".  Each is a count, except "org_unit" which is
 248                 the context org unit and "depth" which is the depth of the context org
 249                 unit.  "depth" is always -1 when the count from a lasso search is
 250                 performed, since depth doesn't mean anything in a lasso context.
 251             /,
 252             type => 'array'
 253         }
 254     }
 255 );
 256
 257 sub record_id_to_copy_count {
 258     my( $self, $client, $org_id, $record_id ) = @_;
 259
 260     return [] unless $record_id;
 261
 262     my $key = $self->api_name =~ /metarecord/ ? 'metarecord' : 'record';
 263     my $staff = $self->api_name =~ /staff/ ? 't' : 'f';
 264
 265     my $data = $U->cstorereq(
 266         "open-ils.cstore.json_query.atomic",
 267         { from => ['asset.' . $key  . '_copy_count' => $org_id => $record_id => $staff] }
 268     );
 269
 270     my @count;
 271     for my $d ( @$data ) { # fix up the key name change required by stored-proc version
 272         $$d{count} = delete $$d{visible};
 273         push @count, $d;
 274     }
 275
 276     return [ sort { $a->{depth} <=> $b->{depth} } @count ];
 277 }
 278
 279 __PACKAGE__->register_method(
 280     method   => "record_has_holdable_copy",
 281     api_name => "open-ils.search.biblio.record.has_holdable_copy",
 282     signature => {
 283         desc => q/Returns a boolean indicating if a record has any holdable copies./,
 284         params => [
 285             {desc => 'Record ID', type => 'number'}
 286         ],
 287         return => {
 288             desc => q/bool indicating if the record has any holdable copies/,
 289             type => 'bool'
 290         }
 291     }
 292 );
 293
 294 __PACKAGE__->register_method(
 295     method   => "record_has_holdable_copy",
 296     api_name => "open-ils.search.biblio.metarecord.has_holdable_copy",
 297     signature => {
 298         desc => q/Returns a boolean indicating if a record has any holdable copies./,
 299         params => [
 300             {desc => 'Record ID', type => 'number'}
 301         ],
 302         return => {
 303             desc => q/bool indicating if the record has any holdable copies/,
 304             type => 'bool'
 305         }
 306     }
 307 );
 308
 309 sub record_has_holdable_copy {
 310     my($self, $client, $record_id ) = @_;
 311
 312     return 0 unless $record_id;
 313
 314     my $key = $self->api_name =~ /metarecord/ ? 'metarecord' : 'record';
 315
 316     my $data = $U->cstorereq(
 317         "open-ils.cstore.json_query.atomic",
 318         { from => ['asset.' . $key . '_has_holdable_copy' => $record_id ] }
 319     );
 320
 321     return ${@$data[0]}{'asset.' . $key . '_has_holdable_copy'} eq 't';
 322
 323 }
 324
 325 __PACKAGE__->register_method(
 326     method   => "biblio_search_tcn",
 327     api_name => "open-ils.search.biblio.tcn",
 328     argc     => 1,
 329     signature => {
 330         desc   => "Retrieve related record ID(s) given a TCN",
 331         params => [
 332             { desc => 'TCN', type => 'string' },
 333             { desc => 'Flag indicating to include deleted records', type => 'string' }
 334         ],
 335         return => {
 336             desc => 'Results object like: { "count": $i, "ids": [...] }',
 337             type => 'object'
 338         }
 339     }
 340
 341 );
 342
 343 sub biblio_search_tcn {
 344
 345     my( $self, $client, $tcn, $include_deleted ) = @_;
 346
 347     $tcn =~ s/^\s+|\s+$//og;
 348
 349     my $e = new_editor();
 350     my $search = {tcn_value => $tcn};
 351     $search->{deleted} = 'f' unless $include_deleted;
 352     my $recs = $e->search_biblio_record_entry( $search, {idlist =>1} );
 353
 354     return { count => scalar(@$recs), ids => $recs };
 355 }
 356
 357
 358 # --------------------------------------------------------------------------------
 359
 360 __PACKAGE__->register_method(
 361     method   => "biblio_barcode_to_copy",
 362     api_name => "open-ils.search.asset.copy.find_by_barcode",
 363 );
 364 sub biblio_barcode_to_copy {
 365     my( $self, $client, $barcode ) = @_;
 366     my( $copy, $evt ) = $U->fetch_copy_by_barcode($barcode);
 367     return $evt if $evt;
 368     return $copy;
 369 }
 370
 371 __PACKAGE__->register_method(
 372     method   => "biblio_id_to_copy",
 373     api_name => "open-ils.search.asset.copy.batch.retrieve",
 374 );
 375 sub biblio_id_to_copy {
 376     my( $self, $client, $ids ) = @_;
 377     $logger->info("Fetching copies @$ids");
 378     return $U->cstorereq(
 379         "open-ils.cstore.direct.asset.copy.search.atomic", { id => $ids } );
 380 }
 381
 382
 383 __PACKAGE__->register_method(
 384     method  => "biblio_id_to_uris",
 385     api_name=> "open-ils.search.asset.uri.retrieve_by_bib",
 386     argc    => 2,
 387     stream  => 1,
 388     signature => q#
 389         @param BibID Which bib record contains the URIs
 390         @param OrgID Where to look for URIs
 391         @param OrgDepth Range adjustment for OrgID
 392         @return A stream or list of 'auri' objects
 393     #
 394
 395 );
 396 sub biblio_id_to_uris {
 397     my( $self, $client, $bib, $org, $depth ) = @_;
 398     die "Org ID required" unless defined($org);
 399     die "Bib ID required" unless defined($bib);
 400
 401     my @params;
 402     push @params, $depth if (defined $depth);
 403
 404     my $ids = $U->cstorereq( "open-ils.cstore.json_query.atomic",
 405         {   select  => { auri => [ 'id' ] },
 406             from    => {
 407                 acn => {
 408                     auricnm => {
 409                         field   => 'call_number',
 410                         fkey    => 'id',
 411                         join    => {
 412                             auri    => {
 413                                 field => 'id',
 414                                 fkey => 'uri',
 415                                 filter  => { active => 't' }
 416                             }
 417                         }
 418                     }
 419                 }
 420             },
 421             where   => {
 422                 '+acn'  => {
 423                     record      => $bib,
 424                     owning_lib  => {
 425                         in  => {
 426                             select  => { aou => [ { column => 'id', transform => 'actor.org_unit_descendants', params => \@params, result_field => 'id' } ] },
 427                             from    => 'aou',
 428                             where   => { id => $org },
 429                             distinct=> 1
 430                         }
 431                     }
 432                 }
 433             },
 434             distinct=> 1,
 435         }
 436     );
 437
 438     my $uris = $U->cstorereq(
 439         "open-ils.cstore.direct.asset.uri.search.atomic",
 440         { id => [ map { (values %$_) } @$ids ] }
 441     );
 442
 443     $client->respond($_) for (@$uris);
 444
 445     return undef;
 446 }
 447
 448
 449 __PACKAGE__->register_method(
 450     method    => "copy_retrieve",
 451     api_name  => "open-ils.search.asset.copy.retrieve",
 452     argc      => 1,
 453     signature => {
 454         desc   => 'Retrieve a copy object based on the Copy ID',
 455         params => [
 456             { desc => 'Copy ID', type => 'number'}
 457         ],
 458         return => {
 459             desc => 'Copy object, event on error'
 460         }
 461     }
 462 );
 463
 464 sub copy_retrieve {
 465     my( $self, $client, $cid ) = @_;
 466     my( $copy, $evt ) = $U->fetch_copy($cid);
 467     return $evt || $copy;
 468 }
 469
 470 __PACKAGE__->register_method(
 471     method   => "volume_retrieve",
 472     api_name => "open-ils.search.asset.call_number.retrieve"
 473 );
 474 sub volume_retrieve {
 475     my( $self, $client, $vid ) = @_;
 476     my $e = new_editor();
 477     my $vol = $e->retrieve_asset_call_number($vid) or return $e->event;
 478     return $vol;
 479 }
 480
 481 __PACKAGE__->register_method(
 482     method        => "fleshed_copy_retrieve_batch",
 483     api_name      => "open-ils.search.asset.copy.fleshed.batch.retrieve",
 484     authoritative => 1,
 485 );
 486
 487 sub fleshed_copy_retrieve_batch {
 488     my( $self, $client, $ids ) = @_;
 489     $logger->info("Fetching fleshed copies @$ids");
 490     return $U->cstorereq(
 491         "open-ils.cstore.direct.asset.copy.search.atomic",
 492         { id => $ids },
 493         { flesh => 1,
 494           flesh_fields => { acp => [ qw/ circ_lib location status stat_cat_entries parts / ] }
 495         });
 496 }
 497
 498
 499 __PACKAGE__->register_method(
 500     method   => "fleshed_copy_retrieve",
 501     api_name => "open-ils.search.asset.copy.fleshed.retrieve",
 502 );
 503
 504 sub fleshed_copy_retrieve {
 505     my( $self, $client, $id ) = @_;
 506     my( $c, $e) = $U->fetch_fleshed_copy($id);
 507     return $e || $c;
 508 }
 509
 510
 511 __PACKAGE__->register_method(
 512     method        => 'fleshed_by_barcode',
 513     api_name      => "open-ils.search.asset.copy.fleshed2.find_by_barcode",
 514     authoritative => 1,
 515 );
 516 sub fleshed_by_barcode {
 517     my( $self, $conn, $barcode ) = @_;
 518     my $e = new_editor();
 519     my $copyid = $e->search_asset_copy(
 520         {barcode => $barcode, deleted => 'f'}, {idlist=>1})->[0]
 521         or return $e->event;
 522     return fleshed_copy_retrieve2( $self, $conn, $copyid);
 523 }
 524
 525
 526 __PACKAGE__->register_method(
 527     method        => "fleshed_copy_retrieve2",
 528     api_name      => "open-ils.search.asset.copy.fleshed2.retrieve",
 529     authoritative => 1,
 530 );
 531
 532 sub fleshed_copy_retrieve2 {
 533     my( $self, $client, $id ) = @_;
 534     my $e = new_editor();
 535     my $copy = $e->retrieve_asset_copy(
 536         [
 537             $id,
 538             {
 539                 flesh        => 2,
 540                 flesh_fields => {
 541                     acp => [
 542                         qw/ location status stat_cat_entry_copy_maps notes age_protect parts peer_record_maps /
 543                     ],
 544                     ascecm => [qw/ stat_cat stat_cat_entry /],
 545                 }
 546             }
 547         ]
 548     ) or return $e->event;
 549
 550     # For backwards compatibility
 551     #$copy->stat_cat_entries($copy->stat_cat_entry_copy_maps);
 552
 553     if( $copy->status->id == OILS_COPY_STATUS_CHECKED_OUT ) {
 554         $copy->circulations(
 555             $e->search_action_circulation(
 556                 [
 557                     { target_copy => $copy->id },
 558                     {
 559                         order_by => { circ => 'xact_start desc' },
 560                         limit => 1
 561                     }
 562                 ]
 563             )
 564         );
 565     }
 566
 567     return $copy;
 568 }
 569
 570
 571 __PACKAGE__->register_method(
 572     method        => 'flesh_copy_custom',
 573     api_name      => 'open-ils.search.asset.copy.fleshed.custom',
 574     authoritative => 1,
 575 );
 576
 577 sub flesh_copy_custom {
 578     my( $self, $conn, $copyid, $fields ) = @_;
 579     my $e = new_editor();
 580     my $copy = $e->retrieve_asset_copy(
 581         [
 582             $copyid,
 583             {
 584                 flesh               => 1,
 585                 flesh_fields    => {
 586                     acp => $fields,
 587                 }
 588             }
 589         ]
 590     ) or return $e->event;
 591     return $copy;
 592 }
 593
 594
 595 __PACKAGE__->register_method(
 596     method   => "biblio_barcode_to_title",
 597     api_name => "open-ils.search.biblio.find_by_barcode",
 598 );
 599
 600 sub biblio_barcode_to_title {
 601     my( $self, $client, $barcode ) = @_;
 602
 603     my $title = $apputils->simple_scalar_request(
 604         "open-ils.storage",
 605         "open-ils.storage.biblio.record_entry.retrieve_by_barcode", $barcode );
 606
 607     return { ids => [ $title->id ], count => 1 } if $title;
 608     return { count => 0 };
 609 }
 610
 611 __PACKAGE__->register_method(
 612     method        => 'title_id_by_item_barcode',
 613     api_name      => 'open-ils.search.bib_id.by_barcode',
 614     authoritative => 1,
 615     signature => {
 616         desc   => 'Retrieve bib record id associated with the copy identified by the given barcode',
 617         params => [
 618             { desc => 'Item barcode', type => 'string' }
 619         ],
 620         return => {
 621             desc => 'Bib record id.'
 622         }
 623     }
 624 );
 625
 626 __PACKAGE__->register_method(
 627     method        => 'title_id_by_item_barcode',
 628     api_name      => 'open-ils.search.multi_home.bib_ids.by_barcode',
 629     authoritative => 1,
 630     signature => {
 631         desc   => 'Retrieve bib record ids associated with the copy identified by the given barcode.  This includes peer bibs for Multi-Home items.',
 632         params => [
 633             { desc => 'Item barcode', type => 'string' }
 634         ],
 635         return => {
 636             desc => 'Array of bib record ids.  First element is the native bib for the item.'
 637         }
 638     }
 639 );
 640
 641
 642 sub title_id_by_item_barcode {
 643     my( $self, $conn, $barcode ) = @_;
 644     my $e = new_editor();
 645     my $copies = $e->search_asset_copy(
 646         [
 647             { deleted => 'f', barcode => $barcode },
 648             {
 649                 flesh => 2,
 650                 flesh_fields => {
 651                     acp => [ 'call_number' ],
 652                     acn => [ 'record' ]
 653                 }
 654             }
 655         ]
 656     );
 657
 658     return $e->event unless @$copies;
 659
 660     if( $self->api_name =~ /multi_home/ ) {
 661         my $multi_home_list = $e->search_biblio_peer_bib_copy_map(
 662             [
 663                 { target_copy => $$copies[0]->id }
 664             ]
 665         );
 666         my @temp =  map { $_->peer_record } @{ $multi_home_list };
 667         unshift @temp, $$copies[0]->call_number->record->id;
 668         return \@temp;
 669     } else {
 670         return $$copies[0]->call_number->record->id;
 671     }
 672 }
 673
 674 __PACKAGE__->register_method(
 675     method        => 'find_peer_bibs',
 676     api_name      => 'open-ils.search.peer_bibs.test',
 677     authoritative => 1,
 678     signature => {
 679         desc   => 'Tests to see if the specified record is a peer record.',
 680         params => [
 681             { desc => 'Biblio record entry Id', type => 'number' }
 682         ],
 683         return => {
 684             desc => 'True if specified id can be found in biblio.peer_bib_copy_map.peer_record.',
 685             type => 'bool'
 686         }
 687     }
 688 );
 689
 690 __PACKAGE__->register_method(
 691     method        => 'find_peer_bibs',
 692     api_name      => 'open-ils.search.peer_bibs',
 693     authoritative => 1,
 694     signature => {
 695         desc   => 'Return acps and mvrs for multi-home items linked to specified peer record.',
 696         params => [
 697             { desc => 'Biblio record entry Id', type => 'number' }
 698         ],
 699         return => {
 700             desc => '{ records => Array of mvrs, items => array of acps }',
 701         }
 702     }
 703 );
 704
 705
 706 sub find_peer_bibs {
 707     my( $self, $client, $doc_id ) = @_;
 708     my $e = new_editor();
 709
 710     my $multi_home_list = $e->search_biblio_peer_bib_copy_map(
 711         [
 712             { peer_record => $doc_id },
 713             {
 714                 flesh => 2,
 715                 flesh_fields => {
 716                     bpbcm => [ 'target_copy', 'peer_type' ],
 717                     acp => [ 'call_number', 'location', 'status', 'peer_record_maps' ]
 718                 }
 719             }
 720         ]
 721     );
 722
 723     if ($self->api_name =~ /test/) {
 724         return scalar( @{$multi_home_list} ) > 0 ? 1 : 0;
 725     }
 726
 727     if (scalar(@{$multi_home_list})==0) {
 728         return [];
 729     }
 730
 731     # create a unique hash of the primary record MVRs for foreign copies
 732     # XXX PLEASE let's change to unAPI2 (supports foreign copies) in the TT opac?!?
 733     my %rec_hash = map {
 734         ($_->target_copy->call_number->record, _records_to_mods( $_->target_copy->call_number->record )->[0])
 735     } @$multi_home_list;
 736
 737     # set the foreign_copy_maps field to an empty array
 738     map { $rec_hash{$_}->foreign_copy_maps([]) } keys( %rec_hash );
 739
 740     # push the maps onto the correct MVRs
 741     for (@$multi_home_list) {
 742         push(
 743             @{$rec_hash{ $_->target_copy->call_number->record }->foreign_copy_maps()},
 744             $_
 745         );
 746     }
 747
 748     return [sort {$a->title cmp $b->title} values(%rec_hash)];
 749 };
 750
 751 __PACKAGE__->register_method(
 752     method   => "biblio_copy_to_mods",
 753     api_name => "open-ils.search.biblio.copy.mods.retrieve",
 754 );
 755
 756 # takes a copy object and returns it fleshed mods object
 757 sub biblio_copy_to_mods {
 758     my( $self, $client, $copy ) = @_;
 759
 760     my $volume = $U->cstorereq(
 761         "open-ils.cstore.direct.asset.call_number.retrieve",
 762         $copy->call_number() );
 763
 764     my $mods = _records_to_mods($volume->record());
 765     $mods = shift @$mods;
 766     $volume->copies([$copy]);
 767     push @{$mods->call_numbers()}, $volume;
 768
 769     return $mods;
 770 }
 771
 772
 773 =head1 NAME
 774
 775 OpenILS::Application::Search::Biblio
 776
 777 =head1 DESCRIPTION
 778
 779 =head2 API METHODS
 780
 781 =head3 open-ils.search.biblio.multiclass.query (arghash, query, docache)
 782
 783 For arghash and docache, see B<open-ils.search.biblio.multiclass>.
 784
 785 The query argument is a string, but built like a hash with key: value pairs.
 786 Recognized search keys include:
 787
 788  keyword (kw) - search keyword(s) *
 789  author  (au) - search author(s)  *
 790  name    (au) - same as author    *
 791  title   (ti) - search title      *
 792  subject (su) - search subject    *
 793  series  (se) - search series     *
 794  lang - limit by language (specify multiple langs with lang:l1 lang:l2 ...)
 795  site - search at specified org unit, corresponds to actor.org_unit.shortname
 796  pref_ou - extend search to specified org unit, corresponds to actor.org_unit.shortname
 797  sort - sort type (title, author, pubdate)
 798  dir  - sort direction (asc, desc)
 799  available - if set to anything other than "false" or "0", limits to available items
 800
 801 * Searching keyword, author, title, subject, and series supports additional search
 802 subclasses, specified with a "|".  For example, C<title|proper:gone with the wind>.
 803
 804 For more, see B<config.metabib_field>.
 805
 806 =cut
 807
 808 foreach (qw/open-ils.search.biblio.multiclass.query
 809             open-ils.search.biblio.multiclass.query.staff
 810             open-ils.search.metabib.multiclass.query
 811             open-ils.search.metabib.multiclass.query.staff/)
 812 {
 813 __PACKAGE__->register_method(
 814     api_name  => $_,
 815     method    => 'multiclass_query',
 816     signature => {
 817         desc   => 'Perform a search query.  The .staff version of the call includes otherwise hidden hits.',
 818         params => [
 819             {name => 'arghash', desc => 'Arg hash (see open-ils.search.biblio.multiclass)',         type => 'object'},
 820             {name => 'query',   desc => 'Raw human-readable query (see perldoc '. __PACKAGE__ .')', type => 'string'},
 821             {name => 'docache', desc => 'Flag for caching (see open-ils.search.biblio.multiclass)', type => 'object'},
 822         ],
 823         return => {
 824             desc => 'Search results from query, like: { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }',
 825             type => 'object',       # TODO: update as miker's new elements are included
 826         }
 827     }
 828 );
 829 }
 830
 831 sub multiclass_query {
 832     my($self, $conn, $arghash, $query, $docache) = @_;
 833
 834     $logger->debug("initial search query => $query");
 835     my $orig_query = $query;
 836
 837     $query =~ s/\+/ /go;
 838     $query =~ s/^\s+//go;
 839
 840     # convert convenience classes (e.g. kw for keyword) to the full class name
 841     # ensure that the convenience class isn't part of a word (e.g. 'playhouse')
 842     $query =~ s/(^|\s)kw(:|\|)/$1keyword$2/go;
 843     $query =~ s/(^|\s)ti(:|\|)/$1title$2/go;
 844     $query =~ s/(^|\s)au(:|\|)/$1author$2/go;
 845     $query =~ s/(^|\s)su(:|\|)/$1subject$2/go;
 846     $query =~ s/(^|\s)se(:|\|)/$1series$2/go;
 847     $query =~ s/(^|\s)name(:|\|)/$1author$2/og;
 848
 849     $logger->debug("cleansed query string => $query");
 850     my $search = {};
 851
 852     my $simple_class_re  = qr/((?:\w+(?:\|\w+)?):[^:]+?)$/;
 853     my $class_list_re    = qr/(?:keyword|title|author|subject|series)/;
 854     my $modifier_list_re = qr/(?:site|dir|sort|lang|available|preflib)/;
 855
 856     my $tmp_value = '';
 857     while ($query =~ s/$simple_class_re//so) {
 858
 859         my $qpart = $1;
 860         my $where = index($qpart,':');
 861         my $type  = substr($qpart, 0, $where++);
 862         my $value = substr($qpart, $where);
 863
 864         if ($type !~ /^(?:$class_list_re|$modifier_list_re)/o) {
 865             $tmp_value = "$qpart $tmp_value";
 866             next;
 867         }
 868
 869         if ($type =~ /$class_list_re/o ) {
 870             $value .= $tmp_value;
 871             $tmp_value = '';
 872         }
 873
 874         next unless $type and $value;
 875
 876         $value =~ s/^\s*//og;
 877         $value =~ s/\s*$//og;
 878         $type = 'sort_dir' if $type eq 'dir';
 879
 880         if($type eq 'site') {
 881             # 'site' is the org shortname.  when using this, we also want
 882             # to search at the requested org's depth
 883             my $e = new_editor();
 884             if(my $org = $e->search_actor_org_unit({shortname => $value})->[0]) {
 885                 $arghash->{org_unit} = $org->id if $org;
 886                 $arghash->{depth} = $e->retrieve_actor_org_unit_type($org->ou_type)->depth;
 887             } else {
 888                 $logger->warn("'site:' query used on invalid org shortname: $value ... ignoring");
 889             }
 890         } elsif($type eq 'pref_ou') {
 891             # 'pref_ou' is the preferred org shortname.
 892             my $e = new_editor();
 893             if(my $org = $e->search_actor_org_unit({shortname => $value})->[0]) {
 894                 $arghash->{pref_ou} = $org->id if $org;
 895             } else {
 896                 $logger->warn("'pref_ou:' query used on invalid org shortname: $value ... ignoring");
 897             }
 898
 899         } elsif($type eq 'available') {
 900             # limit to available
 901             $arghash->{available} = 1 unless $value eq 'false' or $value eq '0';
 902
 903         } elsif($type eq 'lang') {
 904             # collect languages into an array of languages
 905             $arghash->{language} = [] unless $arghash->{language};
 906             push(@{$arghash->{language}}, $value);
 907
 908         } elsif($type =~ /^sort/o) {
 909             # sort and sort_dir modifiers
 910             $arghash->{$type} = $value;
 911
 912         } else {
 913             # append the search term to the term under construction
 914             $search->{$type} =  {} unless $search->{$type};
 915             $search->{$type}->{term} =
 916                 ($search->{$type}->{term}) ? $search->{$type}->{term} . " $value" : $value;
 917         }
 918     }
 919
 920     $query .= " $tmp_value";
 921     $query =~ s/\s+/ /go;
 922     $query =~ s/^\s+//go;
 923     $query =~ s/\s+$//go;
 924
 925     my $type = $arghash->{default_class} || 'keyword';
 926     $type = ($type eq '-') ? 'keyword' : $type;
 927     $type = ($type !~ /^(title|author|keyword|subject|series)(?:\|\w+)?$/o) ? 'keyword' : $type;
 928
 929     if($query) {
 930         # This is the front part of the string before any special tokens were
 931         # parsed OR colon-separated strings that do not denote a class.
 932         # Add this data to the default search class
 933         $search->{$type} =  {} unless $search->{$type};
 934         $search->{$type}->{term} =
 935             ($search->{$type}->{term}) ? $search->{$type}->{term} . " $query" : $query;
 936     }
 937     my $real_search = $arghash->{searches} = { $type => { term => $orig_query } };
 938
 939     # capture the original limit because the search method alters the limit internally
 940     my $ol = $arghash->{limit};
 941
 942     my $sclient = OpenSRF::Utils::SettingsClient->new;
 943
 944     (my $method = $self->api_name) =~ s/\.query//o;
 945
 946     $method =~ s/multiclass/multiclass.staged/
 947         if $sclient->config_value(apps => 'open-ils.search',
 948             app_settings => 'use_staged_search') =~ /true/i;
 949
 950     # XXX This stops the session locale from doing the right thing.
 951     # XXX Revisit this and have it translate to a lang instead of a locale.
 952     #$arghash->{preferred_language} = $U->get_org_locale($arghash->{org_unit})
 953     #    unless $arghash->{preferred_language};
 954
 955     $method = $self->method_lookup($method);
 956     my ($data) = $method->run($arghash, $docache);
 957
 958     $arghash->{searches} = $search if (!$data->{complex_query});
 959
 960     $arghash->{limit} = $ol if $ol;
 961     $data->{compiled_search} = $arghash;
 962     $data->{query} = $orig_query;
 963
 964     $logger->info("compiled search is " . OpenSRF::Utils::JSON->perl2JSON($arghash));
 965
 966     return $data;
 967 }
 968
 969 __PACKAGE__->register_method(
 970     method    => 'cat_search_z_style_wrapper',
 971     api_name  => 'open-ils.search.biblio.zstyle',
 972     stream    => 1,
 973     signature => q/@see open-ils.search.biblio.multiclass/
 974 );
 975
 976 __PACKAGE__->register_method(
 977     method    => 'cat_search_z_style_wrapper',
 978     api_name  => 'open-ils.search.biblio.zstyle.staff',
 979     stream    => 1,
 980     signature => q/@see open-ils.search.biblio.multiclass/
 981 );
 982
 983 sub cat_search_z_style_wrapper {
 984     my $self = shift;
 985     my $client = shift;
 986     my $authtoken = shift;
 987     my $args = shift;
 988
 989     my $cstore = OpenSRF::AppSession->connect('open-ils.cstore');
 990
 991     my $ou = $cstore->request(
 992         'open-ils.cstore.direct.actor.org_unit.search',
 993         { parent_ou => undef }
 994     )->gather(1);
 995
 996     my $result = { service => 'native-evergreen-catalog', records => [] };
 997     my $searchhash = { limit => $$args{limit}, offset => $$args{offset}, org_unit => $ou->id };
 998
 999     $$searchhash{searches}{title}{term}   = $$args{search}{title}   if $$args{search}{title};
1000     $$searchhash{searches}{author}{term}  = $$args{search}{author}  if $$args{search}{author};
1001     $$searchhash{searches}{subject}{term} = $$args{search}{subject} if $$args{search}{subject};
1002     $$searchhash{searches}{keyword}{term} = $$args{search}{keyword} if $$args{search}{keyword};
1003     $$searchhash{searches}{'identifier|isbn'}{term} = $$args{search}{isbn} if $$args{search}{isbn};
1004     $$searchhash{searches}{'identifier|issn'}{term} = $$args{search}{issn} if $$args{search}{issn};
1005     $$searchhash{searches}{'identifier|upc'}{term} = $$args{search}{upc} if $$args{search}{upc};
1006
1007     $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{tcn}       if $$args{search}{tcn};
1008     $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{publisher} if $$args{search}{publisher};
1009     $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{pubdate}   if $$args{search}{pubdate};
1010     $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{item_type} if $$args{search}{item_type};
1011
1012     my $method = 'open-ils.search.biblio.multiclass.staged';
1013     $method .= '.staff' if $self->api_name =~ /staff$/;
1014
1015     my ($list) = $self->method_lookup($method)->run( $searchhash );
1016
1017     if ($list->{count} > 0 and @{$list->{ids}}) {
1018         $result->{count} = $list->{count};
1019
1020         my $records = $cstore->request(
1021             'open-ils.cstore.direct.biblio.record_entry.search.atomic',
1022             { id => [ map { ( $_->[0] ) } @{$list->{ids}} ] }
1023         )->gather(1);
1024
1025         for my $rec ( @$records ) {
1026
1027             my $u = OpenILS::Utils::ModsParser->new();
1028                         $u->start_mods_batch( $rec->marc );
1029                         my $mods = $u->finish_mods_batch();
1030
1031             push @{ $result->{records} }, { mvr => $mods, marcxml => $rec->marc, bibid => $rec->id };
1032
1033         }
1034
1035     }
1036
1037     $cstore->disconnect();
1038     return $result;
1039 }
1040
1041 # ----------------------------------------------------------------------------
1042 # These are the main OPAC search methods
1043 # ----------------------------------------------------------------------------
1044
1045 __PACKAGE__->register_method(
1046     method    => 'the_quest_for_knowledge',
1047     api_name  => 'open-ils.search.biblio.multiclass',
1048     signature => {
1049         desc => "Performs a multi class biblio or metabib search",
1050         params => [
1051             {
1052                 desc => "A search hash with keys: "
1053                       . "searches, org_unit, depth, limit, offset, format, sort, sort_dir.  "
1054                       . "See perldoc " . __PACKAGE__ . " for more detail",
1055                 type => 'object',
1056             },
1057             {
1058                 desc => "A flag to enable/disable searching and saving results in cache (default OFF)",
1059                 type => 'string',
1060             }
1061         ],
1062         return => {
1063             desc => 'An object of the form: '
1064                   . '{ "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }',
1065         }
1066     }
1067 );
1068
1069 =head3 open-ils.search.biblio.multiclass (search-hash, docache)
1070
1071 The search-hash argument can have the following elements:
1072
1073     searches: { "$class" : "$value", ...}           [REQUIRED]
1074     org_unit: The org id to focus the search at
1075     depth   : The org depth
1076     limit   : The search limit      default: 10
1077     offset  : The search offset     default:  0
1078     format  : The MARC format
1079     sort    : What field to sort the results on? [ author | title | pubdate ]
1080     sort_dir: What direction do we sort? [ asc | desc ]
1081     tag_circulated_records : Boolean, if true, records that are in the user's visible checkout history
1082         will be tagged with an additional value ("1") as the last value in the record ID array for
1083         each record.  Requires the 'authtoken'
1084     authtoken : Authentication token string;  When actions are performed that require a user login
1085         (e.g. tagging circulated records), the authentication token is required
1086
1087 The searches element is required, must have a hashref value, and the hashref must contain at least one
1088 of the following classes as a key:
1089
1090     title
1091     author
1092     subject
1093     series
1094     keyword
1095
1096 The value paired with a key is the associated search string.
1097
1098 The docache argument enables/disables searching and saving results in cache (default OFF).
1099
1100 The return object, if successful, will look like:
1101
1102     { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }
1103
1104 =cut
1105
1106 __PACKAGE__->register_method(
1107     method    => 'the_quest_for_knowledge',
1108     api_name  => 'open-ils.search.biblio.multiclass.staff',
1109     signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items.  Otherwise, @see open-ils.search.biblio.multiclass/
1110 );
1111 __PACKAGE__->register_method(
1112     method    => 'the_quest_for_knowledge',
1113     api_name  => 'open-ils.search.metabib.multiclass',
1114     signature => q/@see open-ils.search.biblio.multiclass/
1115 );
1116 __PACKAGE__->register_method(
1117     method    => 'the_quest_for_knowledge',
1118     api_name  => 'open-ils.search.metabib.multiclass.staff',
1119     signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items.  Otherwise, @see open-ils.search.biblio.multiclass/
1120 );
1121
1122 sub the_quest_for_knowledge {
1123     my( $self, $conn, $searchhash, $docache ) = @_;
1124
1125     return { count => 0 } unless $searchhash and
1126         ref $searchhash->{searches} eq 'HASH';
1127
1128     my $method = 'open-ils.storage.biblio.multiclass.search_fts';
1129     my $ismeta = 0;
1130     my @recs;
1131
1132     if($self->api_name =~ /metabib/) {
1133         $ismeta = 1;
1134         $method =~ s/biblio/metabib/o;
1135     }
1136
1137     # do some simple sanity checking
1138     if(!$searchhash->{searches} or
1139         ( !grep { /^(?:title|author|subject|series|keyword|identifier\|is[bs]n)/ } keys %{$searchhash->{searches}} ) ) {
1140         return { count => 0 };
1141     }
1142
1143     my $offset = $searchhash->{offset} ||  0;   # user value or default in local var now
1144     my $limit  = $searchhash->{limit}  || 10;   # user value or default in local var now
1145     my $end    = $offset + $limit - 1;
1146
1147     my $maxlimit = 5000;
1148     $searchhash->{offset} = 0;                  # possible user value overwritten in hash
1149     $searchhash->{limit}  = $maxlimit;          # possible user value overwritten in hash
1150
1151     return { count => 0 } if $offset > $maxlimit;
1152
1153     my @search;
1154     push( @search, ($_ => $$searchhash{$_})) for (sort keys %$searchhash);
1155     my $s = OpenSRF::Utils::JSON->perl2JSON(\@search);
1156     my $ckey = $pfx . md5_hex($method . $s);
1157
1158     $logger->info("bib search for: $s");
1159
1160     $searchhash->{limit} -= $offset;
1161
1162
1163     my $trim = 0;
1164     my $result = ($docache) ? search_cache($ckey, $offset, $limit) : undef;
1165
1166     if(!$result) {
1167
1168         $method .= ".staff" if($self->api_name =~ /staff/);
1169         $method .= ".atomic";
1170
1171         for (keys %$searchhash) {
1172             delete $$searchhash{$_}
1173                 unless defined $$searchhash{$_};
1174         }
1175
1176         $result = $U->storagereq( $method, %$searchhash );
1177         $trim = 1;
1178
1179     } else {
1180         $docache = 0;   # results came FROM cache, so we don't write back
1181     }
1182
1183     return {count => 0} unless ($result && $$result[0]);
1184
1185     @recs = @$result;
1186
1187     my $count = ($ismeta) ? $result->[0]->[3] : $result->[0]->[2];
1188
1189     if($docache) {
1190         # If we didn't get this data from the cache, put it into the cache
1191         # then return the correct offset of records
1192         $logger->debug("putting search cache $ckey\n");
1193         put_cache($ckey, $count, \@recs);
1194     }
1195
1196     if($trim) {
1197         # if we have the full set of data, trim out
1198         # the requested chunk based on limit and offset
1199         my @t;
1200         for ($offset..$end) {
1201             last unless $recs[$_];
1202             push(@t, $recs[$_]);
1203         }
1204         @recs = @t;
1205     }
1206
1207     return { ids => \@recs, count => $count };
1208 }
1209
1210
1211 __PACKAGE__->register_method(
1212     method    => 'staged_search',
1213     api_name  => 'open-ils.search.biblio.multiclass.staged',
1214     signature => {
1215         desc   => 'Staged search filters out unavailable items.  This means that it relies on an estimation strategy for determining ' .
1216                   'how big a "raw" search result chunk (i.e. a "superpage") to obtain prior to filtering.  See "estimation_strategy" in your SRF config.',
1217         params => [
1218             {
1219                 desc => "A search hash with keys: "
1220                       . "searches, limit, offset.  The others are optional, but the 'searches' key/value pair is required, with the value being a hashref.  "
1221                       . "See perldoc " . __PACKAGE__ . " for more detail",
1222                 type => 'object',
1223             },
1224             {
1225                 desc => "A flag to enable/disable searching and saving results in cache, including facets (default OFF)",
1226                 type => 'string',
1227             }
1228         ],
1229         return => {
1230             desc => 'Hash with keys: count, core_limit, superpage_size, superpage_summary, facet_key, ids.  '
1231                   . 'The superpage_summary value is a hashref that includes keys: estimated_hit_count, visible.',
1232             type => 'object',
1233         }
1234     }
1235 );
1236 __PACKAGE__->register_method(
1237     method    => 'staged_search',
1238     api_name  => 'open-ils.search.biblio.multiclass.staged.staff',
1239     signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items.  Otherwise, @see open-ils.search.biblio.multiclass.staged/
1240 );
1241 __PACKAGE__->register_method(
1242     method    => 'staged_search',
1243     api_name  => 'open-ils.search.metabib.multiclass.staged',
1244     signature => q/@see open-ils.search.biblio.multiclass.staged/
1245 );
1246 __PACKAGE__->register_method(
1247     method    => 'staged_search',
1248     api_name  => 'open-ils.search.metabib.multiclass.staged.staff',
1249     signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items.  Otherwise, @see open-ils.search.biblio.multiclass.staged/
1250 );
1251
1252 sub staged_search {
1253     my($self, $conn, $search_hash, $docache) = @_;
1254
1255     my $IAmMetabib = ($self->api_name =~ /metabib/) ? 1 : 0;
1256
1257     my $method = $IAmMetabib?
1258         'open-ils.storage.metabib.multiclass.staged.search_fts':
1259         'open-ils.storage.biblio.multiclass.staged.search_fts';
1260
1261     $method .= '.staff' if $self->api_name =~ /staff$/;
1262     $method .= '.atomic';
1263
1264     return {count => 0} unless (
1265         $search_hash and
1266         $search_hash->{searches} and
1267         scalar( keys %{$search_hash->{searches}} ));
1268
1269     my $search_duration;
1270     my $user_offset = $search_hash->{offset} ||  0; # user-specified offset
1271     my $user_limit  = $search_hash->{limit}  || 10;
1272     my $ignore_facet_classes  = $search_hash->{ignore_facet_classes};
1273     $user_offset = ($user_offset >= 0) ? $user_offset :  0;
1274     $user_limit  = ($user_limit  >= 0) ? $user_limit  : 10;
1275
1276
1277     # we're grabbing results on a per-superpage basis, which means the
1278     # limit and offset should coincide with superpage boundaries
1279     $search_hash->{offset} = 0;
1280     $search_hash->{limit} = $superpage_size;
1281
1282     # force a well-known check_limit
1283     $search_hash->{check_limit} = $superpage_size;
1284     # restrict total tested to superpage size * number of superpages
1285     $search_hash->{core_limit}  = $superpage_size * $max_superpages;
1286
1287     # Set the configured estimation strategy, defaults to 'inclusion'.
1288     my $estimation_strategy = OpenSRF::Utils::SettingsClient
1289         ->new
1290         ->config_value(
1291             apps => 'open-ils.search', app_settings => 'estimation_strategy'
1292         ) || 'inclusion';
1293     $search_hash->{estimation_strategy} = $estimation_strategy;
1294
1295     # pull any existing results from the cache
1296     my $key = search_cache_key($method, $search_hash);
1297     my $facet_key = $key.'_facets';
1298     my $cache_data = $cache->get_cache($key) || {};
1299
1300     # First, we want to make sure that someone else isn't currently trying to perform exactly
1301     # this same search.  The point is to allow just one instance of a search to fill the needs
1302     # of all concurrent, identical searches.  This will avoid spammy searches killing the
1303     # database without requiring admins to start locking some IP addresses out entirely.
1304     #
1305     # There's still a tiny race condition where 2 might run, but without sigificantly more code
1306     # and complexity, this is close to the best we can do.
1307
1308     if ($cache_data->{running}) { # someone is already doing the search...
1309         my $stop_looping = time() + $cache_timeout;
1310         while ( sleep(1) and time() < $stop_looping ) { # sleep for a second ... maybe they'll finish
1311             $cache_data = $cache->get_cache($key) || {};
1312             last if (!$cache_data->{running});
1313         }
1314     } elsif (!$cache_data->{0}) { # we're the first ... let's give it a try
1315         $cache->put_cache($key, { running => $$ }, $cache_timeout / 3);
1316     }
1317
1318     # keep retrieving results until we find enough to
1319     # fulfill the user-specified limit and offset
1320     my $all_results = [];
1321     my $page; # current superpage
1322     my $est_hit_count = 0;
1323     my $current_page_summary = {};
1324     my $global_summary = {checked => 0, visible => 0, excluded => 0, deleted => 0, total => 0};
1325     my $is_real_hit_count = 0;
1326     my $new_ids = [];
1327
1328     for($page = 0; $page < $max_superpages; $page++) {
1329
1330         my $data = $cache_data->{$page};
1331         my $results;
1332         my $summary;
1333
1334         $logger->debug("staged search: analyzing superpage $page");
1335
1336         if($data) {
1337             # this window of results is already cached
1338             $logger->debug("staged search: found cached results");
1339             $summary = $data->{summary};
1340             $results = $data->{results};
1341
1342         } else {
1343             # retrieve the window of results from the database
1344             $logger->debug("staged search: fetching results from the database");
1345             $search_hash->{skip_check} = $page * $superpage_size;
1346             my $start = time;
1347             $results = $U->storagereq($method, %$search_hash);
1348             $search_duration = time - $start;
1349             $summary = shift(@$results) if $results;
1350
1351             unless($summary) {
1352                 $logger->info("search timed out: duration=$search_duration: params=".
1353                     OpenSRF::Utils::JSON->perl2JSON($search_hash));
1354                 return {count => 0};
1355             }
1356
1357             $logger->info("staged search: DB call took $search_duration seconds and returned ".scalar(@$results)." rows, including summary");
1358
1359             my $hc = $summary->{estimated_hit_count} || $summary->{visible};
1360             if($hc == 0) {
1361                 $logger->info("search returned 0 results: duration=$search_duration: params=".
1362                     OpenSRF::Utils::JSON->perl2JSON($search_hash));
1363             }
1364
1365             # Create backwards-compatible result structures
1366             if($IAmMetabib) {
1367                 $results = [map {[$_->{id}, $_->{rel}, $_->{record}]} @$results];
1368             } else {
1369                 $results = [map {[$_->{id}]} @$results];
1370             }
1371
1372             push @$new_ids, grep {defined($_)} map {$_->[0]} @$results;
1373             $results = [grep {defined $_->[0]} @$results];
1374             cache_staged_search_page($key, $page, $summary, $results) if $docache;
1375         }
1376
1377         tag_circulated_records($search_hash->{authtoken}, $results, $IAmMetabib)
1378             if $search_hash->{tag_circulated_records} and $search_hash->{authtoken};
1379
1380         $current_page_summary = $summary;
1381
1382         # add the new set of results to the set under construction
1383         push(@$all_results, @$results);
1384
1385         my $current_count = scalar(@$all_results);
1386
1387         $est_hit_count = $summary->{estimated_hit_count} || $summary->{visible}
1388             if $page == 0;
1389
1390         $logger->debug("staged search: located $current_count, with estimated hits=".
1391             ($summary->{estimated_hit_count} || "none") .
1392             " : visible=" . ($summary->{visible} || "none") . ", checked=" .
1393             ($summary->{checked} || "none")
1394         );
1395
1396         if (defined($summary->{estimated_hit_count})) {
1397             foreach (qw/ checked visible excluded deleted /) {
1398                 $global_summary->{$_} += $summary->{$_};
1399             }
1400             $global_summary->{total} = $summary->{total};
1401         }
1402
1403         # we've found all the possible hits
1404         last if $current_count == $summary->{visible}
1405             and not defined $summary->{estimated_hit_count};
1406
1407         # we've found enough results to satisfy the requested limit/offset
1408         last if $current_count >= ($user_limit + $user_offset);
1409
1410         # we've scanned all possible hits
1411         if($summary->{checked} < $superpage_size) {
1412             $est_hit_count = scalar(@$all_results);
1413             # we have all possible results in hand, so we know the final hit count
1414             $is_real_hit_count = 1;
1415             last;
1416         }
1417     }
1418
1419     # Let other backends grab our data now that we're done.
1420     $cache_data = $cache->get_cache($key);
1421     if ($$cache_data{running} and $$cache_data{running} == $$) {
1422         delete $$cache_data{running};
1423         $cache->put_cache($key, $cache_data, $cache_timeout);
1424     }
1425
1426     my @results = grep {defined $_} @$all_results[$user_offset..($user_offset + $user_limit - 1)];
1427
1428     # refine the estimate if we have more than one superpage
1429     if ($page > 0 and not $is_real_hit_count) {
1430         if ($global_summary->{checked} >= $global_summary->{total}) {
1431             $est_hit_count = $global_summary->{visible};
1432         } else {
1433             my $updated_hit_count = $U->storagereq(
1434                 'open-ils.storage.fts_paging_estimate',
1435                 $global_summary->{checked},
1436                 $global_summary->{visible},
1437                 $global_summary->{excluded},
1438                 $global_summary->{deleted},
1439                 $global_summary->{total}
1440             );
1441             $est_hit_count = $updated_hit_count->{$estimation_strategy};
1442         }
1443     }
1444
1445     $conn->respond_complete(
1446         {
1447             count             => $est_hit_count,
1448             core_limit        => $search_hash->{core_limit},
1449             superpage_size    => $search_hash->{check_limit},
1450             superpage_summary => $current_page_summary,
1451             facet_key         => $facet_key,
1452             ids               => \@results
1453         }
1454     );
1455
1456     cache_facets($facet_key, $new_ids, $IAmMetabib, $ignore_facet_classes) if $docache;
1457
1458     return undef;
1459 }
1460
1461 sub tag_circulated_records {
1462     my ($auth, $results, $metabib) = @_;
1463     my $e = new_editor(authtoken => $auth);
1464     return $results unless $e->checkauth;
1465
1466     my $query = {
1467         select   => { acn => [{ column => 'record', alias => 'tagme' }] },
1468         from     => { acp => 'acn' },
1469         where    => { id => { in => { from => ['action.usr_visible_circ_copies', $e->requestor->id] } } },
1470         distinct => 1
1471     };
1472
1473     if ($metabib) {
1474         $query = {
1475             select   => { mmsm => [{ column => 'metarecord', alias => 'tagme' }] },
1476             from     => 'mmsm',
1477             where    => { source => { in => $query } },
1478             distinct => 1
1479         };
1480     }
1481
1482     # Give me the distinct set of bib records that exist in the user's visible circulation history
1483     my $circ_recs = $e->json_query( $query );
1484
1485     # if the record appears in the circ history, push a 1 onto
1486     # the rec array structure to indicate truthiness
1487     for my $rec (@$results) {
1488         push(@$rec, 1) if grep { $_->{tagme} eq $$rec[0] } @$circ_recs;
1489     }
1490
1491     $results
1492 }
1493
1494 # creates a unique token to represent the query in the cache
1495 sub search_cache_key {
1496     my $method = shift;
1497     my $search_hash = shift;
1498     my @sorted;
1499     for my $key (sort keys %$search_hash) {
1500         push(@sorted, ($key => $$search_hash{$key}))
1501             unless $key eq 'limit'  or
1502                    $key eq 'offset' or
1503                    $key eq 'skip_check';
1504     }
1505     my $s = OpenSRF::Utils::JSON->perl2JSON(\@sorted);
1506     return $pfx . md5_hex($method . $s);
1507 }
1508
1509 sub retrieve_cached_facets {
1510     my $self   = shift;
1511     my $client = shift;
1512     my $key    = shift;
1513     my $limit    = shift;
1514
1515     return undef unless ($key and $key =~ /_facets$/);
1516
1517     my $blob = $cache->get_cache($key) || {};
1518
1519     my $facets = {};
1520     if ($limit) {
1521        for my $f ( keys %$blob ) {
1522             my @sorted = map{ { $$_[1] => $$_[0] } } sort {$$b[0] <=> $$a[0] || $$a[1] cmp $$b[1]} map { [$$blob{$f}{$_}, $_] } keys %{ $$blob{$f} };
1523             @sorted = @sorted[0 .. $limit - 1] if (scalar(@sorted) > $limit);
1524             for my $s ( @sorted ) {
1525                 my ($k) = keys(%$s);
1526                 my ($v) = values(%$s);
1527                 $$facets{$f}{$k} = $v;
1528             }
1529         }
1530     } else {
1531         $facets = $blob;
1532     }
1533
1534     return $facets;
1535 }
1536
1537 __PACKAGE__->register_method(
1538     method   => "retrieve_cached_facets",
1539     api_name => "open-ils.search.facet_cache.retrieve",
1540     signature => {
1541         desc   => 'Returns facet data derived from a specific search based on a key '.
1542                   'generated by open-ils.search.biblio.multiclass.staged and friends.',
1543         params => [
1544             {
1545                 desc => "The facet cache key returned with the initial search as the facet_key hash value",
1546                 type => 'string',
1547             }
1548         ],
1549         return => {
1550             desc => 'Two level hash of facet values.  Top level key is the facet id defined on the config.metabib_field table.  '.
1551                     'Second level key is a string facet value.  Datum attached to each facet value is the number of distinct records, '.
1552                     'or metarecords for a metarecord search, which use that facet value and are visible to the search at the time of '.
1553                     'facet retrieval.  These counts are calculated for all superpages that have been checked for visibility.',
1554             type => 'object',
1555         }
1556     }
1557 );
1558
1559
1560 sub cache_facets {
1561     # add facets for this search to the facet cache
1562     my($key, $results, $metabib, $ignore) = @_;
1563     my $data = $cache->get_cache($key);
1564     $data ||= {};
1565
1566     return undef unless (@$results);
1567
1568     # The query we're constructing
1569     #
1570     # select  mfae.field as id,
1571     #         mfae.value,
1572     #         count(distinct mmrsm.appropriate-id-field )
1573     #   from  metabib.facet_entry mfae
1574     #         join metabib.metarecord_sourc_map mmrsm on (mfae.source = mmrsm.source)
1575     #   where mmrsm.appropriate-id-field in IDLIST
1576     #   group by 1,2;
1577
1578     my $count_field = $metabib ? 'metarecord' : 'source';
1579     my $query = {
1580         select  => {
1581             mfae => [ { column => 'field', alias => 'id'}, 'value' ],
1582             mmrsm => [{
1583                 transform => 'count',
1584                 distinct => 1,
1585                 column => $count_field,
1586                 alias => 'count',
1587                 aggregate => 1
1588             }]
1589         },
1590         from    => {
1591             mfae => {
1592                 mmrsm => { field => 'source', fkey => 'source' },
1593                 cmf   => { field => 'id', fkey => 'field' }
1594             }
1595         },
1596         where   => {
1597             '+mmrsm' => { $count_field => $results },
1598             '+cmf'   => { facet_field => 't' }
1599         }
1600     };
1601
1602     $query->{where}->{'+cmf'}->{field_class} = {'not in' => $ignore}
1603         if ref($ignore) and @$ignore > 0;
1604
1605     my $facets = OpenILS::Utils::CStoreEditor->new->json_query($query, {substream => 1});
1606
1607     for my $facet (@$facets) {
1608         next unless ($facet->{value});
1609         $data->{$facet->{id}}->{$facet->{value}} += $facet->{count};
1610     }
1611
1612     $logger->info("facet compilation: cached with key=$key");
1613
1614     $cache->put_cache($key, $data, $cache_timeout);
1615 }
1616
1617 sub cache_staged_search_page {
1618     # puts this set of results into the cache
1619     my($key, $page, $summary, $results) = @_;
1620     my $data = $cache->get_cache($key);
1621     $data ||= {};
1622     $data->{$page} = {
1623         summary => $summary,
1624         results => $results
1625     };
1626
1627     $logger->info("staged search: cached with key=$key, superpage=$page, estimated=".
1628         ($summary->{estimated_hit_count} || "none") .
1629         ", visible=" . ($summary->{visible} || "none")
1630     );
1631
1632     $cache->put_cache($key, $data, $cache_timeout);
1633 }
1634
1635 sub search_cache {
1636
1637     my $key     = shift;
1638     my $offset  = shift;
1639     my $limit   = shift;
1640     my $start   = $offset;
1641     my $end     = $offset + $limit - 1;
1642
1643     $logger->debug("searching cache for $key : $start..$end\n");
1644
1645     return undef unless $cache;
1646     my $data = $cache->get_cache($key);
1647
1648     return undef unless $data;
1649
1650     my $count = $data->[0];
1651     $data = $data->[1];
1652
1653     return undef unless $offset < $count;
1654
1655     my @result;
1656     for( my $i = $offset; $i <= $end; $i++ ) {
1657         last unless my $d = $$data[$i];
1658         push( @result, $d );
1659     }
1660
1661     $logger->debug("search_cache found ".scalar(@result)." items for count=$count, start=$start, end=$end");
1662
1663     return \@result;
1664 }
1665
1666
1667 sub put_cache {
1668     my( $key, $count, $data ) = @_;
1669     return undef unless $cache;
1670     $logger->debug("search_cache putting ".
1671         scalar(@$data)." items at key $key with timeout $cache_timeout");
1672     $cache->put_cache($key, [ $count, $data ], $cache_timeout);
1673 }
1674
1675
1676 __PACKAGE__->register_method(
1677     method   => "biblio_mrid_to_modsbatch_batch",
1678     api_name => "open-ils.search.biblio.metarecord.mods_slim.batch.retrieve"
1679 );
1680
1681 sub biblio_mrid_to_modsbatch_batch {
1682     my( $self, $client, $mrids) = @_;
1683     # warn "Performing mrid_to_modsbatch_batch..."; # unconditional warn
1684     my @mods;
1685     my $method = $self->method_lookup("open-ils.search.biblio.metarecord.mods_slim.retrieve");
1686     for my $id (@$mrids) {
1687         next unless defined $id;
1688         my ($m) = $method->run($id);
1689         push @mods, $m;
1690     }
1691     return \@mods;
1692 }
1693
1694
1695 foreach (qw /open-ils.search.biblio.metarecord.mods_slim.retrieve
1696              open-ils.search.biblio.metarecord.mods_slim.retrieve.staff/)
1697     {
1698     __PACKAGE__->register_method(
1699         method    => "biblio_mrid_to_modsbatch",
1700         api_name  => $_,
1701         signature => {
1702             desc   => "Returns the mvr associated with a given metarecod. If none exists, it is created.  "
1703                     . "As usual, the .staff version of this method will include otherwise hidden records.",
1704             params => [
1705                 { desc => 'Metarecord ID', type => 'number' },
1706                 { desc => '(Optional) Search filters hash with possible keys: format, org, depth', type => 'object' }
1707             ],
1708             return => {
1709                 desc => 'MVR Object, event on error',
1710             }
1711         }
1712     );
1713 }
1714
1715 sub biblio_mrid_to_modsbatch {
1716     my( $self, $client, $mrid, $args) = @_;
1717
1718     # warn "Grabbing mvr for $mrid\n";    # unconditional warn
1719
1720     my ($mr, $evt) = _grab_metarecord($mrid);
1721     return $evt unless $mr;
1722
1723     my $mvr = biblio_mrid_check_mvr($self, $client, $mr) ||
1724               biblio_mrid_make_modsbatch($self, $client, $mr);
1725
1726     return $mvr unless ref($args);
1727
1728     # Here we find the lead record appropriate for the given filters
1729     # and use that for the title and author of the metarecord
1730     my $format = $$args{format};
1731     my $org    = $$args{org};
1732     my $depth  = $$args{depth};
1733
1734     return $mvr unless $format or $org or $depth;
1735
1736     my $method = "open-ils.storage.ordered.metabib.metarecord.records";
1737     $method = "$method.staff" if $self->api_name =~ /staff/o;
1738
1739     my $rec = $U->storagereq($method, $format, $org, $depth, 1);
1740
1741     if( my $mods = $U->record_to_mvr($rec) ) {
1742
1743         $mvr->title( $mods->title );
1744         $mvr->author($mods->author);
1745         $logger->debug("mods_slim updating title and ".
1746             "author in mvr with ".$mods->title." : ".$mods->author);
1747     }
1748
1749     return $mvr;
1750 }
1751
1752 # converts a metarecord to an mvr
1753 sub _mr_to_mvr {
1754     my $mr = shift;
1755     my $perl = OpenSRF::Utils::JSON->JSON2perl($mr->mods());
1756     return Fieldmapper::metabib::virtual_record->new($perl);
1757 }
1758
1759 # checks to see if a metarecord has mods, if so returns true;
1760
1761 __PACKAGE__->register_method(
1762     method   => "biblio_mrid_check_mvr",
1763     api_name => "open-ils.search.biblio.metarecord.mods_slim.check",
1764     notes    => "Takes a metarecord ID or a metarecord object and returns true "
1765               . "if the metarecord already has an mvr associated with it."
1766 );
1767
1768 sub biblio_mrid_check_mvr {
1769     my( $self, $client, $mrid ) = @_;
1770     my $mr;
1771
1772     my $evt;
1773     if(ref($mrid)) { $mr = $mrid; }
1774     else { ($mr, $evt) = _grab_metarecord($mrid); }
1775     return $evt if $evt;
1776
1777     # warn "Checking mvr for mr " . $mr->id . "\n";   # unconditional warn
1778
1779     return _mr_to_mvr($mr) if $mr->mods();
1780     return undef;
1781 }
1782
1783 sub _grab_metarecord {
1784     my $mrid = shift;
1785     my $e = new_editor();
1786     my $mr = $e->retrieve_metabib_metarecord($mrid) or return ( undef, $e->event );
1787     return ($mr);
1788 }
1789
1790
1791 __PACKAGE__->register_method(
1792     method   => "biblio_mrid_make_modsbatch",
1793     api_name => "open-ils.search.biblio.metarecord.mods_slim.create",
1794     notes    => "Takes either a metarecord ID or a metarecord object. "
1795               . "Forces the creations of an mvr for the given metarecord. "
1796               . "The created mvr is returned."
1797 );
1798
1799 sub biblio_mrid_make_modsbatch {
1800     my( $self, $client, $mrid ) = @_;
1801
1802     my $e = new_editor();
1803
1804     my $mr;
1805     if( ref($mrid) ) {
1806         $mr = $mrid;
1807         $mrid = $mr->id;
1808     } else {
1809         $mr = $e->retrieve_metabib_metarecord($mrid)
1810             or return $e->event;
1811     }
1812
1813     my $masterid = $mr->master_record;
1814     $logger->info("creating new mods batch for metarecord=$mrid, master record=$masterid");
1815
1816     my $ids = $U->storagereq(
1817         'open-ils.storage.ordered.metabib.metarecord.records.staff.atomic', $mrid);
1818     return undef unless @$ids;
1819
1820     my $master = $e->retrieve_biblio_record_entry($masterid)
1821         or return $e->event;
1822
1823     # start the mods batch
1824     my $u = OpenILS::Utils::ModsParser->new();
1825     $u->start_mods_batch( $master->marc );
1826
1827     # grab all of the sub-records and shove them into the batch
1828     my @ids = grep { $_ ne $masterid } @$ids;
1829     #my $subrecs = (@ids) ? $e->batch_retrieve_biblio_record_entry(\@ids) : [];
1830
1831     my $subrecs = [];
1832     if(@$ids) {
1833         for my $i (@$ids) {
1834             my $r = $e->retrieve_biblio_record_entry($i);
1835             push( @$subrecs, $r ) if $r;
1836         }
1837     }
1838
1839     for(@$subrecs) {
1840         $logger->debug("adding record ".$_->id." to mods batch for metarecord=$mrid");
1841         $u->push_mods_batch( $_->marc ) if $_->marc;
1842     }
1843
1844
1845     # finish up and send to the client
1846     my $mods = $u->finish_mods_batch();
1847     $mods->doc_id($mrid);
1848     $client->respond_complete($mods);
1849
1850
1851     # now update the mods string in the db
1852     my $string = OpenSRF::Utils::JSON->perl2JSON($mods->decast);
1853     $mr->mods($string);
1854
1855     $e = new_editor(xact => 1);
1856     $e->update_metabib_metarecord($mr)
1857         or $logger->error("Error setting mods text on metarecord $mrid : " . Dumper($e->event));
1858     $e->finish;
1859
1860     return undef;
1861 }
1862
1863
1864 # converts a mr id into a list of record ids
1865
1866 foreach (qw/open-ils.search.biblio.metarecord_to_records
1867             open-ils.search.biblio.metarecord_to_records.staff/)
1868 {
1869     __PACKAGE__->register_method(
1870         method    => "biblio_mrid_to_record_ids",
1871         api_name  => $_,
1872         signature => {
1873             desc   => "Fetch record IDs corresponding to a meta-record ID, with optional search filters. "
1874                     . "As usual, the .staff version of this method will include otherwise hidden records.",
1875             params => [
1876                 { desc => 'Metarecord ID', type => 'number' },
1877                 { desc => '(Optional) Search filters hash with possible keys: format, org, depth', type => 'object' }
1878             ],
1879             return => {
1880                 desc => 'Results object like {count => $i, ids =>[...]}',
1881                 type => 'object'
1882             }
1883
1884         }
1885     );
1886 }
1887
1888 sub biblio_mrid_to_record_ids {
1889     my( $self, $client, $mrid, $args ) = @_;
1890
1891     my $format = $$args{format};
1892     my $org    = $$args{org};
1893     my $depth  = $$args{depth};
1894
1895     my $method = "open-ils.storage.ordered.metabib.metarecord.records.atomic";
1896     $method =~ s/atomic/staff\.atomic/o if $self->api_name =~ /staff/o;
1897     my $recs = $U->storagereq($method, $mrid, $format, $org, $depth);
1898
1899     return { count => scalar(@$recs), ids => $recs };
1900 }
1901
1902
1903 __PACKAGE__->register_method(
1904     method   => "biblio_record_to_marc_html",
1905     api_name => "open-ils.search.biblio.record.html"
1906 );
1907
1908 __PACKAGE__->register_method(
1909     method   => "biblio_record_to_marc_html",
1910     api_name => "open-ils.search.authority.to_html"
1911 );
1912
1913 # Persistent parsers and setting objects
1914 my $parser = XML::LibXML->new();
1915 my $xslt   = XML::LibXSLT->new();
1916 my $marc_sheet;
1917 my $slim_marc_sheet;
1918 my $settings_client = OpenSRF::Utils::SettingsClient->new();
1919
1920 sub biblio_record_to_marc_html {
1921     my($self, $client, $recordid, $slim, $marcxml) = @_;
1922
1923     my $sheet;
1924     my $dir = $settings_client->config_value("dirs", "xsl");
1925
1926     if($slim) {
1927         unless($slim_marc_sheet) {
1928             my $xsl = $settings_client->config_value(
1929                 "apps", "open-ils.search", "app_settings", 'marc_html_xsl_slim');
1930             if($xsl) {
1931                 $xsl = $parser->parse_file("$dir/$xsl");
1932                 $slim_marc_sheet = $xslt->parse_stylesheet($xsl);
1933             }
1934         }
1935         $sheet = $slim_marc_sheet;
1936     }
1937
1938     unless($sheet) {
1939         unless($marc_sheet) {
1940             my $xsl_key = ($slim) ? 'marc_html_xsl_slim' : 'marc_html_xsl';
1941             my $xsl = $settings_client->config_value(
1942                 "apps", "open-ils.search", "app_settings", 'marc_html_xsl');
1943             $xsl = $parser->parse_file("$dir/$xsl");
1944             $marc_sheet = $xslt->parse_stylesheet($xsl);
1945         }
1946         $sheet = $marc_sheet;
1947     }
1948
1949     my $record;
1950     unless($marcxml) {
1951         my $e = new_editor();
1952         if($self->api_name =~ /authority/) {
1953             $record = $e->retrieve_authority_record_entry($recordid)
1954                 or return $e->event;
1955         } else {
1956             $record = $e->retrieve_biblio_record_entry($recordid)
1957                 or return $e->event;
1958         }
1959         $marcxml = $record->marc;
1960     }
1961
1962     my $xmldoc = $parser->parse_string($marcxml);
1963     my $html = $sheet->transform($xmldoc);
1964     return $html->documentElement->toString();
1965 }
1966
1967 __PACKAGE__->register_method(
1968     method    => "format_biblio_record_entry",
1969     api_name  => "open-ils.search.biblio.record.print",
1970     signature => {
1971         desc   => 'Returns a printable version of the specified bib record',
1972         params => [
1973             { desc => 'Biblio record entry ID or array of IDs', type => 'number' },
1974         ],
1975         return => {
1976             desc => q/An action_trigger.event object or error event./,
1977             type => 'object',
1978         }
1979     }
1980 );
1981 __PACKAGE__->register_method(
1982     method    => "format_biblio_record_entry",
1983     api_name  => "open-ils.search.biblio.record.email",
1984     signature => {
1985         desc   => 'Emails an A/T templated version of the specified bib records to the authorized user',
1986         params => [
1987             { desc => 'Authentication token',  type => 'string'},
1988             { desc => 'Biblio record entry ID or array of IDs', type => 'number' },
1989         ],
1990         return => {
1991             desc => q/Undefined on success, otherwise an error event./,
1992             type => 'object',
1993         }
1994     }
1995 );
1996
1997 sub format_biblio_record_entry {
1998     my($self, $conn, $arg1, $arg2) = @_;
1999
2000     my $for_print = ($self->api_name =~ /print/);
2001     my $for_email = ($self->api_name =~ /email/);
2002
2003     my $e; my $auth; my $bib_id; my $context_org;
2004
2005     if ($for_print) {
2006         $bib_id = $arg1;
2007         $context_org = $arg2 || $U->get_org_tree->id;
2008         $e = new_editor(xact => 1);
2009     } elsif ($for_email) {
2010         $auth = $arg1;
2011         $bib_id = $arg2;
2012         $e = new_editor(authtoken => $auth, xact => 1);
2013         return $e->die_event unless $e->checkauth;
2014         $context_org = $e->requestor->home_ou;
2015     }
2016
2017     my $bib_ids;
2018     if (ref $bib_id ne 'ARRAY') {
2019         $bib_ids = [ $bib_id ];
2020     } else {
2021         $bib_ids = $bib_id;
2022     }
2023
2024     my $bucket = Fieldmapper::container::biblio_record_entry_bucket->new;
2025     $bucket->btype('temp');
2026     $bucket->name('format_biblio_record_entry ' . $U->create_uuid_string);
2027     if ($for_email) {
2028         $bucket->owner($e->requestor)
2029     } else {
2030         $bucket->owner(1);
2031     }
2032     my $bucket_obj = $e->create_container_biblio_record_entry_bucket($bucket);
2033
2034     for my $id (@$bib_ids) {
2035
2036         my $bib = $e->retrieve_biblio_record_entry([$id]) or return $e->die_event;
2037
2038         my $bucket_entry = Fieldmapper::container::biblio_record_entry_bucket_item->new;
2039         $bucket_entry->target_biblio_record_entry($bib);
2040         $bucket_entry->bucket($bucket_obj->id);
2041         $e->create_container_biblio_record_entry_bucket_item($bucket_entry);
2042     }
2043
2044     $e->commit;
2045
2046     if ($for_print) {
2047
2048         return $U->fire_object_event(undef, 'biblio.format.record_entry.print', [ $bucket ], $context_org);
2049
2050     } elsif ($for_email) {
2051
2052         $U->create_events_for_hook('biblio.format.record_entry.email', $bucket, $context_org, undef, undef, 1);
2053     }
2054
2055     return undef;
2056 }
2057
2058
2059 __PACKAGE__->register_method(
2060     method   => "retrieve_all_copy_statuses",
2061     api_name => "open-ils.search.config.copy_status.retrieve.all"
2062 );
2063
2064 sub retrieve_all_copy_statuses {
2065     my( $self, $client ) = @_;
2066     return new_editor()->retrieve_all_config_copy_status();
2067 }
2068
2069
2070 __PACKAGE__->register_method(
2071     method   => "copy_counts_per_org",
2072     api_name => "open-ils.search.biblio.copy_counts.retrieve"
2073 );
2074
2075 __PACKAGE__->register_method(
2076     method   => "copy_counts_per_org",
2077     api_name => "open-ils.search.biblio.copy_counts.retrieve.staff"
2078 );
2079
2080 sub copy_counts_per_org {
2081     my( $self, $client, $record_id ) = @_;
2082
2083     warn "Retreiveing copy copy counts for record $record_id and method " . $self->api_name . "\n";
2084
2085     my $method = "open-ils.storage.biblio.record_entry.global_copy_count.atomic";
2086     if($self->api_name =~ /staff/) { $method =~ s/atomic/staff\.atomic/; }
2087
2088     my $counts = $apputils->simple_scalar_request(
2089         "open-ils.storage", $method, $record_id );
2090
2091     $counts = [ sort {$a->[0] <=> $b->[0]} @$counts ];
2092     return $counts;
2093 }
2094
2095
2096 __PACKAGE__->register_method(
2097     method   => "copy_count_summary",
2098     api_name => "open-ils.search.biblio.copy_counts.summary.retrieve",
2099     notes    => "returns an array of these: "
2100               . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, <status1_count>, <status2_count>,...] "
2101               . "where statusx is a copy status name.  The statuses are sorted by ID.",
2102 );
2103
2104
2105 sub copy_count_summary {
2106     my( $self, $client, $rid, $org, $depth ) = @_;
2107     $org   ||= 1;
2108     $depth ||= 0;
2109     my $data = $U->storagereq(
2110         'open-ils.storage.biblio.record_entry.status_copy_count.atomic', $rid, $org, $depth );
2111
2112     return [ sort {
2113         (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2114         cmp
2115         (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2116     } @$data ];
2117 }
2118
2119 __PACKAGE__->register_method(
2120     method   => "copy_location_count_summary",
2121     api_name => "open-ils.search.biblio.copy_location_counts.summary.retrieve",
2122     notes    => "returns an array of these: "
2123               . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, copy_location, <status1_count>, <status2_count>,...] "
2124               . "where statusx is a copy status name.  The statuses are sorted by ID.",
2125 );
2126
2127 sub copy_location_count_summary {
2128     my( $self, $client, $rid, $org, $depth ) = @_;
2129     $org   ||= 1;
2130     $depth ||= 0;
2131     my $data = $U->storagereq(
2132         'open-ils.storage.biblio.record_entry.status_copy_location_count.atomic', $rid, $org, $depth );
2133
2134     return [ sort {
2135         (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2136         cmp
2137         (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2138
2139         || $a->[4] cmp $b->[4]
2140     } @$data ];
2141 }
2142
2143 __PACKAGE__->register_method(
2144     method   => "copy_count_location_summary",
2145     api_name => "open-ils.search.biblio.copy_counts.location.summary.retrieve",
2146     notes    => "returns an array of these: "
2147               . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, <status1_count>, <status2_count>,...] "
2148               . "where statusx is a copy status name.  The statuses are sorted by ID."
2149 );
2150
2151 sub copy_count_location_summary {
2152     my( $self, $client, $rid, $org, $depth ) = @_;
2153     $org   ||= 1;
2154     $depth ||= 0;
2155     my $data = $U->storagereq(
2156         'open-ils.storage.biblio.record_entry.status_copy_location_count.atomic', $rid, $org, $depth );
2157     return [ sort {
2158         (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2159         cmp
2160         (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2161     } @$data ];
2162 }
2163
2164
2165 foreach (qw/open-ils.search.biblio.marc
2166             open-ils.search.biblio.marc.staff/)
2167 {
2168 __PACKAGE__->register_method(
2169     method    => "marc_search",
2170     api_name  => $_,
2171     signature => {
2172         desc   => 'Fetch biblio IDs based on MARC record criteria.  '
2173                 . 'As usual, the .staff version of the search includes otherwise hidden records',
2174         params => [
2175             {
2176                 desc => 'Search hash (required) with possible elements: searches, limit, offset, sort, sort_dir. ' .
2177                         'See perldoc ' . __PACKAGE__ . ' for more detail.',
2178                 type => 'object'
2179             },
2180             {desc => 'timeout (optional)',  type => 'number'}
2181         ],
2182         return => {
2183             desc => 'Results object like: { "count": $i, "ids": [...] }',
2184             type => 'object'
2185         }
2186     }
2187 );
2188 }
2189
2190 =head3 open-ils.search.biblio.marc (arghash, timeout)
2191
2192 As elsewhere the arghash is the required argument, and must be a hashref.  The keys are:
2193
2194     searches: complex query object  (required)
2195     org_unit: The org ID to focus the search at
2196     depth   : The org depth
2197     limit   : integer search limit      default: 10
2198     offset  : integer search offset     default:  0
2199     sort    : What field to sort the results on? [ author | title | pubdate ]
2200     sort_dir: In what direction do we sort? [ asc | desc ]
2201
2202 Additional keys to refine search criteria:
2203
2204     audience : Audience
2205     language : Language (code)
2206     lit_form : Literary form
2207     item_form: Item form
2208     item_type: Item type
2209     format   : The MARC format
2210
2211 Please note that the specific strings to be used in the "addtional keys" will be entirely
2212 dependent on your loaded data.
2213
2214 All keys except "searches" are optional.
2215 The "searches" value must be an arrayref of hashref elements, including keys "term" and "restrict".
2216
2217 For example, an arg hash might look like:
2218
2219     $arghash = {
2220         searches => [
2221             {
2222                 term     => "harry",
2223                 restrict => [
2224                     {
2225                         tag => 245,
2226                         subfield => "a"
2227                     }
2228                     # ...
2229                 ]
2230             }
2231             # ...
2232         ],
2233         org_unit  => 1,
2234         limit     => 5,
2235         sort      => "author",
2236         item_type => "g"
2237     }
2238
2239 The arghash is eventually passed to the SRF call:
2240 L<open-ils.storage.biblio.full_rec.multi_search[.staff].atomic>
2241
2242 Presently, search uses the cache unconditionally.
2243
2244 =cut
2245
2246 # FIXME: that example above isn't actually tested.
2247 # FIXME: sort and limit added.  item_type not tested yet.
2248 # TODO: docache option?
2249 sub marc_search {
2250     my( $self, $conn, $args, $timeout ) = @_;
2251
2252     my $method = 'open-ils.storage.biblio.full_rec.multi_search';
2253     $method .= ".staff" if $self->api_name =~ /staff/;
2254     $method .= ".atomic";
2255
2256     my $limit = $args->{limit} || 10;
2257     my $offset = $args->{offset} || 0;
2258
2259     # allow caller to pass in a call timeout since MARC searches
2260     # can take longer than the default 60-second timeout.
2261     # Default to 2 mins.  Arbitrarily cap at 5 mins.
2262     $timeout = 120 if !$timeout or $timeout > 300;
2263
2264     my @search;
2265     push( @search, ($_ => $$args{$_}) ) for (sort keys %$args);
2266     my $ckey = $pfx . md5_hex($method . OpenSRF::Utils::JSON->perl2JSON(\@search));
2267
2268     my $recs = search_cache($ckey, $offset, $limit);
2269
2270     if(!$recs) {
2271
2272         my $ses = OpenSRF::AppSession->create('open-ils.storage');
2273         my $req = $ses->request($method, %$args);
2274         my $resp = $req->recv($timeout);
2275
2276         if($resp and $recs = $resp->content) {
2277             put_cache($ckey, scalar(@$recs), $recs);
2278         } else {
2279             $recs = [];
2280         }
2281
2282         $ses->kill_me;
2283     }
2284
2285     my $count = 0;
2286     $count = $recs->[0]->[2] if $recs->[0] and $recs->[0]->[2];
2287     my @recs = map { $_->[0] } @$recs;
2288
2289     return { ids => \@recs, count => $count };
2290 }
2291
2292
2293 foreach my $isbn_method (qw/
2294     open-ils.search.biblio.isbn
2295     open-ils.search.biblio.isbn.staff
2296 /) {
2297 __PACKAGE__->register_method(
2298     method    => "biblio_search_isbn",
2299     api_name  => $isbn_method,
2300     signature => {
2301         desc   => 'Retrieve biblio IDs for a given ISBN. The .staff version of the call includes otherwise hidden hits.',
2302         params => [
2303             {desc => 'ISBN', type => 'string'}
2304         ],
2305         return => {
2306             desc => 'Results object like: { "count": $i, "ids": [...] }',
2307             type => 'object'
2308         }
2309     }
2310 );
2311 }
2312
2313 sub biblio_search_isbn {
2314     my( $self, $client, $isbn ) = @_;
2315     $logger->debug("Searching ISBN $isbn");
2316     # the previous implementation of this method was essentially unlimited,
2317     # so we will set our limit very high and let multiclass.query provide any
2318     # actual limit
2319     # XXX: if making this unlimited is deemed important, we might consider
2320     # reworking 'open-ils.storage.id_list.biblio.record_entry.search.isbn',
2321     # which is functionally deprecated at this point, or a custom call to
2322     # 'open-ils.storage.biblio.multiclass.search_fts'
2323
2324     my $isbn_method = 'open-ils.search.biblio.multiclass.query';
2325     if ($self->api_name =~ m/.staff$/) {
2326         $isbn_method .= '.staff';
2327     }
2328
2329     my $method = $self->method_lookup($isbn_method);
2330     my ($search_result) = $method->run({'limit' => 1000000}, "identifier|isbn:$isbn");
2331     my @recs = map { $_->[0] } @{$search_result->{'ids'}};
2332     return { ids => \@recs, count => $search_result->{'count'} };
2333 }
2334
2335 __PACKAGE__->register_method(
2336     method   => "biblio_search_isbn_batch",
2337     api_name => "open-ils.search.biblio.isbn_list",
2338 );
2339
2340 # XXX: see biblio_search_isbn() for note concerning 'limit'
2341 sub biblio_search_isbn_batch {
2342     my( $self, $client, $isbn_list ) = @_;
2343     $logger->debug("Searching ISBNs @$isbn_list");
2344     my @recs = (); my %rec_set = ();
2345     my $method = $self->method_lookup('open-ils.search.biblio.multiclass.query');
2346     foreach my $isbn ( @$isbn_list ) {
2347         my ($search_result) = $method->run({'limit' => 1000000}, "identifier|isbn:$isbn");
2348         my @recs_subset = map { $_->[0] } @{$search_result->{'ids'}};
2349         foreach my $rec (@recs_subset) {
2350             if (! $rec_set{ $rec }) {
2351                 $rec_set{ $rec } = 1;
2352                 push @recs, $rec;
2353             }
2354         }
2355     }
2356     return { ids => \@recs, count => scalar(@recs) };
2357 }
2358
2359 foreach my $issn_method (qw/
2360     open-ils.search.biblio.issn
2361     open-ils.search.biblio.issn.staff
2362 /) {
2363 __PACKAGE__->register_method(
2364     method   => "biblio_search_issn",
2365     api_name => $issn_method,
2366     signature => {
2367         desc   => 'Retrieve biblio IDs for a given ISSN',
2368         params => [
2369             {desc => 'ISBN', type => 'string'}
2370         ],
2371         return => {
2372             desc => 'Results object like: { "count": $i, "ids": [...] }',
2373             type => 'object'
2374         }
2375     }
2376 );
2377 }
2378
2379 sub biblio_search_issn {
2380     my( $self, $client, $issn ) = @_;
2381     $logger->debug("Searching ISSN $issn");
2382     # the previous implementation of this method was essentially unlimited,
2383     # so we will set our limit very high and let multiclass.query provide any
2384     # actual limit
2385     # XXX: if making this unlimited is deemed important, we might consider
2386     # reworking 'open-ils.storage.id_list.biblio.record_entry.search.issn',
2387     # which is functionally deprecated at this point, or a custom call to
2388     # 'open-ils.storage.biblio.multiclass.search_fts'
2389
2390     my $issn_method = 'open-ils.search.biblio.multiclass.query';
2391     if ($self->api_name =~ m/.staff$/) {
2392         $issn_method .= '.staff';
2393     }
2394
2395     my $method = $self->method_lookup($issn_method);
2396     my ($search_result) = $method->run({'limit' => 1000000}, "identifier|issn:$issn");
2397     my @recs = map { $_->[0] } @{$search_result->{'ids'}};
2398     return { ids => \@recs, count => $search_result->{'count'} };
2399 }
2400
2401
2402 __PACKAGE__->register_method(
2403     method    => "fetch_mods_by_copy",
2404     api_name  => "open-ils.search.biblio.mods_from_copy",
2405     argc      => 1,
2406     signature => {
2407         desc    => 'Retrieve MODS record given an attached copy ID',
2408         params  => [
2409             { desc => 'Copy ID', type => 'number' }
2410         ],
2411         returns => {
2412             desc => 'MODS record, event on error or uncataloged item'
2413         }
2414     }
2415 );
2416
2417 sub fetch_mods_by_copy {
2418     my( $self, $client, $copyid ) = @_;
2419     my ($record, $evt) = $apputils->fetch_record_by_copy( $copyid );
2420     return $evt if $evt;
2421     return OpenILS::Event->new('ITEM_NOT_CATALOGED') unless $record->marc;
2422     return $apputils->record_to_mvr($record);
2423 }
2424
2425
2426 # -------------------------------------------------------------------------------------
2427
2428 __PACKAGE__->register_method(
2429     method   => "cn_browse",
2430     api_name => "open-ils.search.callnumber.browse.target",
2431     notes    => "Starts a callnumber browse"
2432 );
2433
2434 __PACKAGE__->register_method(
2435     method   => "cn_browse",
2436     api_name => "open-ils.search.callnumber.browse.page_up",
2437     notes    => "Returns the previous page of callnumbers",
2438 );
2439
2440 __PACKAGE__->register_method(
2441     method   => "cn_browse",
2442     api_name => "open-ils.search.callnumber.browse.page_down",
2443     notes    => "Returns the next page of callnumbers",
2444 );
2445
2446
2447 # RETURNS array of arrays like so: label, owning_lib, record, id
2448 sub cn_browse {
2449     my( $self, $client, @params ) = @_;
2450     my $method;
2451
2452     $method = 'open-ils.storage.asset.call_number.browse.target.atomic'
2453         if( $self->api_name =~ /target/ );
2454     $method = 'open-ils.storage.asset.call_number.browse.page_up.atomic'
2455         if( $self->api_name =~ /page_up/ );
2456     $method = 'open-ils.storage.asset.call_number.browse.page_down.atomic'
2457         if( $self->api_name =~ /page_down/ );
2458
2459     return $apputils->simplereq( 'open-ils.storage', $method, @params );
2460 }
2461 # -------------------------------------------------------------------------------------
2462
2463 __PACKAGE__->register_method(
2464     method        => "fetch_cn",
2465     api_name      => "open-ils.search.callnumber.retrieve",
2466     authoritative => 1,
2467     notes         => "retrieves a callnumber based on ID",
2468 );
2469
2470 sub fetch_cn {
2471     my( $self, $client, $id ) = @_;
2472
2473     my $e = new_editor();
2474     my( $cn, $evt ) = $apputils->fetch_callnumber( $id, 0, $e );
2475     return $evt if $evt;
2476     return $cn;
2477 }
2478
2479 __PACKAGE__->register_method(
2480     method        => "fetch_fleshed_cn",
2481     api_name      => "open-ils.search.callnumber.fleshed.retrieve",
2482     authoritative => 1,
2483     notes         => "retrieves a callnumber based on ID, fleshing prefix, suffix, and label_class",
2484 );
2485
2486 sub fetch_fleshed_cn {
2487     my( $self, $client, $id ) = @_;
2488
2489     my $e = new_editor();
2490     my( $cn, $evt ) = $apputils->fetch_callnumber( $id, 1, $e );
2491     return $evt if $evt;
2492     return $cn;
2493 }
2494
2495
2496 __PACKAGE__->register_method(
2497     method    => "fetch_copy_by_cn",
2498     api_name  => 'open-ils.search.copies_by_call_number.retrieve',
2499     signature => q/
2500         Returns an array of copy ID's by callnumber ID
2501         @param cnid The callnumber ID
2502         @return An array of copy IDs
2503     /
2504 );
2505
2506 sub fetch_copy_by_cn {
2507     my( $self, $conn, $cnid ) = @_;
2508     return $U->cstorereq(
2509         'open-ils.cstore.direct.asset.copy.id_list.atomic',
2510         { call_number => $cnid, deleted => 'f' } );
2511 }
2512
2513 __PACKAGE__->register_method(
2514     method    => 'fetch_cn_by_info',
2515     api_name  => 'open-ils.search.call_number.retrieve_by_info',
2516     signature => q/
2517         @param label The callnumber label
2518         @param record The record the cn is attached to
2519         @param org The owning library of the cn
2520         @return The callnumber object
2521     /
2522 );
2523
2524
2525 sub fetch_cn_by_info {
2526     my( $self, $conn, $label, $record, $org ) = @_;
2527     return $U->cstorereq(
2528         'open-ils.cstore.direct.asset.call_number.search',
2529         { label => $label, record => $record, owning_lib => $org, deleted => 'f' });
2530 }
2531
2532
2533
2534 __PACKAGE__->register_method(
2535     method   => 'bib_extras',
2536     api_name => 'open-ils.search.biblio.lit_form_map.retrieve.all',
2537     ctype => 'lit_form'
2538 );
2539 __PACKAGE__->register_method(
2540     method   => 'bib_extras',
2541     api_name => 'open-ils.search.biblio.item_form_map.retrieve.all',
2542     ctype => 'item_form'
2543 );
2544 __PACKAGE__->register_method(
2545     method   => 'bib_extras',
2546     api_name => 'open-ils.search.biblio.item_type_map.retrieve.all',
2547     ctype => 'item_type',
2548 );
2549 __PACKAGE__->register_method(
2550     method   => 'bib_extras',
2551     api_name => 'open-ils.search.biblio.bib_level_map.retrieve.all',
2552     ctype => 'bib_level'
2553 );
2554 __PACKAGE__->register_method(
2555     method   => 'bib_extras',
2556     api_name => 'open-ils.search.biblio.audience_map.retrieve.all',
2557     ctype => 'audience'
2558 );
2559
2560 sub bib_extras {
2561     my $self = shift;
2562     $logger->warn("deprecation warning: " .$self->api_name);
2563
2564     my $e = new_editor();
2565
2566     my $ctype = $self->{ctype};
2567     my $ccvms = $e->search_config_coded_value_map({ctype => $ctype});
2568
2569     my @objs;
2570     for my $ccvm (@$ccvms) {
2571         my $obj = "Fieldmapper::config::${ctype}_map"->new;
2572         $obj->value($ccvm->value);
2573         $obj->code($ccvm->code);
2574         $obj->description($ccvm->description) if $obj->can('description');
2575         push(@objs, $obj);
2576     }
2577
2578     return \@objs;
2579 }
2580
2581
2582
2583 __PACKAGE__->register_method(
2584     method    => 'fetch_slim_record',
2585     api_name  => 'open-ils.search.biblio.record_entry.slim.retrieve',
2586     signature => {
2587         desc   => "Retrieves one or more biblio.record_entry without the attached marcxml",
2588         params => [
2589             { desc => 'Array of Record IDs', type => 'array' }
2590         ],
2591         return => {
2592             desc => 'Array of biblio records, event on error'
2593         }
2594     }
2595 );
2596
2597 sub fetch_slim_record {
2598     my( $self, $conn, $ids ) = @_;
2599
2600     my $editor = new_editor();
2601     my @res;
2602     for( @$ids ) {
2603         return $editor->event unless
2604             my $r = $editor->retrieve_biblio_record_entry($_);
2605         $r->clear_marc;
2606         push(@res, $r);
2607     }
2608     return \@res;
2609 }
2610
2611 __PACKAGE__->register_method(
2612     method    => 'rec_hold_parts',
2613     api_name  => 'open-ils.search.biblio.record_hold_parts',
2614     signature => q/
2615        Returns a list of {label :foo, id : bar} objects for viable monograph parts for a given record
2616     /
2617 );
2618
2619 sub rec_hold_parts {
2620     my( $self, $conn, $args ) = @_;
2621
2622     my $rec        = $$args{record};
2623     my $mrec       = $$args{metarecord};
2624     my $pickup_lib = $$args{pickup_lib};
2625     my $e = new_editor();
2626
2627     my $query = {
2628         select => {bmp => ['id', 'label']},
2629         from => 'bmp',
2630         where => {
2631             id => {
2632                 in => {
2633                     select => {'acpm' => ['part']},
2634                     from => {acpm => {acp => {join => {acn => {join => 'bre'}}}}},
2635                     where => {
2636                         '+acp' => {'deleted' => 'f'},
2637                         '+bre' => {id => $rec}
2638                     },
2639                     distinct => 1,
2640                 }
2641             },
2642             deleted => 'f'
2643         },
2644         order_by =>[{class=>'bmp', field=>'label_sortkey'}]
2645     };
2646
2647     if(defined $pickup_lib) {
2648         my $hard_boundary = $U->ou_ancestor_setting_value($pickup_lib, OILS_SETTING_HOLD_HARD_BOUNDARY);
2649         if($hard_boundary) {
2650             my $orgs = $e->json_query({from => ['actor.org_unit_descendants' => $pickup_lib, $hard_boundary]});
2651             $query->{where}->{'+acp'}->{circ_lib} = [ map { $_->{id} } @$orgs ];
2652         }
2653     }
2654
2655     return $e->json_query($query);
2656 }
2657
2658
2659
2660
2661 __PACKAGE__->register_method(
2662     method    => 'rec_to_mr_rec_descriptors',
2663     api_name  => 'open-ils.search.metabib.record_to_descriptors',
2664     signature => q/
2665         specialized method...
2666         Given a biblio record id or a metarecord id,
2667         this returns a list of metabib.record_descriptor
2668         objects that live within the same metarecord
2669         @param args Object of args including:
2670     /
2671 );
2672
2673 sub rec_to_mr_rec_descriptors {
2674     my( $self, $conn, $args ) = @_;
2675
2676     my $rec        = $$args{record};
2677     my $mrec       = $$args{metarecord};
2678     my $item_forms = $$args{item_forms};
2679     my $item_types = $$args{item_types};
2680     my $item_lang  = $$args{item_lang};
2681     my $pickup_lib = $$args{pickup_lib};
2682
2683     my $hard_boundary = $U->ou_ancestor_setting_value($pickup_lib, OILS_SETTING_HOLD_HARD_BOUNDARY) if (defined $pickup_lib);
2684
2685     my $e = new_editor();
2686     my $recs;
2687
2688     if( !$mrec ) {
2689         my $map = $e->search_metabib_metarecord_source_map({source => $rec});
2690         return $e->event unless @$map;
2691         $mrec = $$map[0]->metarecord;
2692     }
2693
2694     $recs = $e->search_metabib_metarecord_source_map({metarecord => $mrec});
2695     return $e->event unless @$recs;
2696
2697     my @recs = map { $_->source } @$recs;
2698     my $search = { record => \@recs };
2699     $search->{item_form} = $item_forms if $item_forms and @$item_forms;
2700     $search->{item_type} = $item_types if $item_types and @$item_types;
2701     $search->{item_lang} = $item_lang  if $item_lang;
2702
2703     my $desc = $e->search_metabib_record_descriptor($search);
2704
2705     my $query = {
2706         distinct => 1,
2707         select   => { 'bre' => ['id'] },
2708         from     => {
2709             'bre' => {
2710                 'acn' => {
2711                     'join' => {
2712                         'acp' => {"join" => {"acpl" => {}, "ccs" => {}}}
2713                       }
2714                   }
2715              }
2716         },
2717         where => {
2718             '+bre' => { id => \@recs },
2719             '+acp' => {
2720                 holdable => 't',
2721                 deleted  => 'f'
2722             },
2723             "+ccs" => { holdable => 't' },
2724             "+acpl" => { holdable => 't', deleted => 'f' }
2725         }
2726     };
2727
2728     if ($hard_boundary) { # 0 (or "top") is the same as no setting
2729         my $orgs = $e->json_query(
2730             { from => [ 'actor.org_unit_descendants' => $pickup_lib, $hard_boundary ] }
2731         ) or return $e->die_event;
2732
2733         $query->{where}->{"+acp"}->{circ_lib} = [ map { $_->{id} } @$orgs ];
2734     }
2735
2736     my $good_records = $e->json_query($query) or return $e->die_event;
2737
2738     my @keep;
2739     for my $d (@$desc) {
2740         if ( grep { $d->record == $_->{id} } @$good_records ) {
2741             push @keep, $d;
2742         }
2743     }
2744
2745     $desc = \@keep;
2746
2747     return { metarecord => $mrec, descriptors => $desc };
2748 }
2749
2750
2751 __PACKAGE__->register_method(
2752     method   => 'fetch_age_protect',
2753     api_name => 'open-ils.search.copy.age_protect.retrieve.all',
2754 );
2755
2756 sub fetch_age_protect {
2757     return new_editor()->retrieve_all_config_rule_age_hold_protect();
2758 }
2759
2760
2761 __PACKAGE__->register_method(
2762     method   => 'copies_by_cn_label',
2763     api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label',
2764 );
2765
2766 __PACKAGE__->register_method(
2767     method   => 'copies_by_cn_label',
2768     api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label.staff',
2769 );
2770
2771 sub copies_by_cn_label {
2772     my( $self, $conn, $record, $cn_parts, $circ_lib ) = @_;
2773     my $e = new_editor();
2774     my $cnp_id = $cn_parts->[0] eq '' ? -1 : $e->search_asset_call_number_prefix({label => $cn_parts->[0]}, {idlist=>1})->[0];
2775     my $cns_id = $cn_parts->[2] eq '' ? -1 : $e->search_asset_call_number_suffix({label => $cn_parts->[2]}, {idlist=>1})->[0];
2776     my $cns = $e->search_asset_call_number({record => $record, prefix => $cnp_id, label => $cn_parts->[1], suffix => $cns_id, deleted => 'f'}, {idlist=>1});
2777     return [] unless @$cns;
2778
2779     # show all non-deleted copies in the staff client ...
2780     if ($self->api_name =~ /staff$/o) {
2781         return $e->search_asset_copy({call_number => $cns, circ_lib => $circ_lib, deleted => 'f'}, {idlist=>1});
2782     }
2783
2784     # ... otherwise, grab the copies ...
2785     my $copies = $e->search_asset_copy(
2786         [ {call_number => $cns, circ_lib => $circ_lib, deleted => 'f', opac_visible => 't'},
2787           {flesh => 1, flesh_fields => { acp => [ qw/location status/] } }
2788         ]
2789     );
2790
2791     # ... and test for location and status visibility
2792     return [ map { ($U->is_true($_->location->opac_visible) && $U->is_true($_->status->opac_visible)) ? ($_->id) : () } @$copies ];
2793 }
2794
2795
2796 1;
2797