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 sleep);
  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     # arghash only really supports limit/offset anymore
 833     my($self, $conn, $arghash, $query, $docache) = @_;
 834
 835     if ($query) {
 836         $query =~ s/\+/ /go;
 837         $query =~ s/^\s+//go;
 838         $query =~ s/\s+/ /go;
 839         $arghash->{query} = $query
 840     }
 841
 842     $logger->debug("initial search query => $query") if $query;
 843
 844     (my $method = $self->api_name) =~ s/\.query/.staged/o;
 845     return $self->method_lookup($method)->dispatch($arghash, $docache);
 846
 847 }
 848
 849 __PACKAGE__->register_method(
 850     method    => 'cat_search_z_style_wrapper',
 851     api_name  => 'open-ils.search.biblio.zstyle',
 852     stream    => 1,
 853     signature => q/@see open-ils.search.biblio.multiclass/
 854 );
 855
 856 __PACKAGE__->register_method(
 857     method    => 'cat_search_z_style_wrapper',
 858     api_name  => 'open-ils.search.biblio.zstyle.staff',
 859     stream    => 1,
 860     signature => q/@see open-ils.search.biblio.multiclass/
 861 );
 862
 863 sub cat_search_z_style_wrapper {
 864     my $self = shift;
 865     my $client = shift;
 866     my $authtoken = shift;
 867     my $args = shift;
 868
 869     my $cstore = OpenSRF::AppSession->connect('open-ils.cstore');
 870
 871     my $ou = $cstore->request(
 872         'open-ils.cstore.direct.actor.org_unit.search',
 873         { parent_ou => undef }
 874     )->gather(1);
 875
 876     my $result = { service => 'native-evergreen-catalog', records => [] };
 877     my $searchhash = { limit => $$args{limit}, offset => $$args{offset}, org_unit => $ou->id };
 878
 879     $$searchhash{searches}{title}{term}   = $$args{search}{title}   if $$args{search}{title};
 880     $$searchhash{searches}{author}{term}  = $$args{search}{author}  if $$args{search}{author};
 881     $$searchhash{searches}{subject}{term} = $$args{search}{subject} if $$args{search}{subject};
 882     $$searchhash{searches}{keyword}{term} = $$args{search}{keyword} if $$args{search}{keyword};
 883     $$searchhash{searches}{'identifier|isbn'}{term} = $$args{search}{isbn} if $$args{search}{isbn};
 884     $$searchhash{searches}{'identifier|issn'}{term} = $$args{search}{issn} if $$args{search}{issn};
 885     $$searchhash{searches}{'identifier|upc'}{term} = $$args{search}{upc} if $$args{search}{upc};
 886
 887     $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{tcn}       if $$args{search}{tcn};
 888     $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{publisher} if $$args{search}{publisher};
 889     $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{pubdate}   if $$args{search}{pubdate};
 890     $$searchhash{searches}{keyword}{term} .= join ' ', $$searchhash{searches}{keyword}{term}, $$args{search}{item_type} if $$args{search}{item_type};
 891
 892     my $method = 'open-ils.search.biblio.multiclass.staged';
 893     $method .= '.staff' if $self->api_name =~ /staff$/;
 894
 895     my ($list) = $self->method_lookup($method)->run( $searchhash );
 896
 897     if ($list->{count} > 0 and @{$list->{ids}}) {
 898         $result->{count} = $list->{count};
 899
 900         my $records = $cstore->request(
 901             'open-ils.cstore.direct.biblio.record_entry.search.atomic',
 902             { id => [ map { ( $_->[0] ) } @{$list->{ids}} ] }
 903         )->gather(1);
 904
 905         for my $rec ( @$records ) {
 906
 907             my $u = OpenILS::Utils::ModsParser->new();
 908                         $u->start_mods_batch( $rec->marc );
 909                         my $mods = $u->finish_mods_batch();
 910
 911             push @{ $result->{records} }, { mvr => $mods, marcxml => $rec->marc, bibid => $rec->id };
 912
 913         }
 914
 915     }
 916
 917     $cstore->disconnect();
 918     return $result;
 919 }
 920
 921 # ----------------------------------------------------------------------------
 922 # These are the main OPAC search methods
 923 # ----------------------------------------------------------------------------
 924
 925 __PACKAGE__->register_method(
 926     method    => 'the_quest_for_knowledge',
 927     api_name  => 'open-ils.search.biblio.multiclass',
 928     signature => {
 929         desc => "Performs a multi class biblio or metabib search",
 930         params => [
 931             {
 932                 desc => "A search hash with keys: "
 933                       . "searches, org_unit, depth, limit, offset, format, sort, sort_dir.  "
 934                       . "See perldoc " . __PACKAGE__ . " for more detail",
 935                 type => 'object',
 936             },
 937             {
 938                 desc => "A flag to enable/disable searching and saving results in cache (default OFF)",
 939                 type => 'string',
 940             }
 941         ],
 942         return => {
 943             desc => 'An object of the form: '
 944                   . '{ "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }',
 945         }
 946     }
 947 );
 948
 949 =head3 open-ils.search.biblio.multiclass (search-hash, docache)
 950
 951 The search-hash argument can have the following elements:
 952
 953     searches: { "$class" : "$value", ...}           [REQUIRED]
 954     org_unit: The org id to focus the search at
 955     depth   : The org depth
 956     limit   : The search limit      default: 10
 957     offset  : The search offset     default:  0
 958     format  : The MARC format
 959     sort    : What field to sort the results on? [ author | title | pubdate ]
 960     sort_dir: What direction do we sort? [ asc | desc ]
 961     tag_circulated_records : Boolean, if true, records that are in the user's visible checkout history
 962         will be tagged with an additional value ("1") as the last value in the record ID array for
 963         each record.  Requires the 'authtoken'
 964     authtoken : Authentication token string;  When actions are performed that require a user login
 965         (e.g. tagging circulated records), the authentication token is required
 966
 967 The searches element is required, must have a hashref value, and the hashref must contain at least one
 968 of the following classes as a key:
 969
 970     title
 971     author
 972     subject
 973     series
 974     keyword
 975
 976 The value paired with a key is the associated search string.
 977
 978 The docache argument enables/disables searching and saving results in cache (default OFF).
 979
 980 The return object, if successful, will look like:
 981
 982     { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }
 983
 984 =cut
 985
 986 __PACKAGE__->register_method(
 987     method    => 'the_quest_for_knowledge',
 988     api_name  => 'open-ils.search.biblio.multiclass.staff',
 989     signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items.  Otherwise, @see open-ils.search.biblio.multiclass/
 990 );
 991 __PACKAGE__->register_method(
 992     method    => 'the_quest_for_knowledge',
 993     api_name  => 'open-ils.search.metabib.multiclass',
 994     signature => q/@see open-ils.search.biblio.multiclass/
 995 );
 996 __PACKAGE__->register_method(
 997     method    => 'the_quest_for_knowledge',
 998     api_name  => 'open-ils.search.metabib.multiclass.staff',
 999     signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items.  Otherwise, @see open-ils.search.biblio.multiclass/
1000 );
1001
1002 sub the_quest_for_knowledge {
1003     my( $self, $conn, $searchhash, $docache ) = @_;
1004
1005     return { count => 0 } unless $searchhash and
1006         ref $searchhash->{searches} eq 'HASH';
1007
1008     my $method = 'open-ils.storage.biblio.multiclass.search_fts';
1009     my $ismeta = 0;
1010     my @recs;
1011
1012     if($self->api_name =~ /metabib/) {
1013         $ismeta = 1;
1014         $method =~ s/biblio/metabib/o;
1015     }
1016
1017     # do some simple sanity checking
1018     if(!$searchhash->{searches} or
1019         ( !grep { /^(?:title|author|subject|series|keyword|identifier\|is[bs]n)/ } keys %{$searchhash->{searches}} ) ) {
1020         return { count => 0 };
1021     }
1022
1023     my $offset = $searchhash->{offset} ||  0;   # user value or default in local var now
1024     my $limit  = $searchhash->{limit}  || 10;   # user value or default in local var now
1025     my $end    = $offset + $limit - 1;
1026
1027     my $maxlimit = 5000;
1028     $searchhash->{offset} = 0;                  # possible user value overwritten in hash
1029     $searchhash->{limit}  = $maxlimit;          # possible user value overwritten in hash
1030
1031     return { count => 0 } if $offset > $maxlimit;
1032
1033     my @search;
1034     push( @search, ($_ => $$searchhash{$_})) for (sort keys %$searchhash);
1035     my $s = OpenSRF::Utils::JSON->perl2JSON(\@search);
1036     my $ckey = $pfx . md5_hex($method . $s);
1037
1038     $logger->info("bib search for: $s");
1039
1040     $searchhash->{limit} -= $offset;
1041
1042
1043     my $trim = 0;
1044     my $result = ($docache) ? search_cache($ckey, $offset, $limit) : undef;
1045
1046     if(!$result) {
1047
1048         $method .= ".staff" if($self->api_name =~ /staff/);
1049         $method .= ".atomic";
1050
1051         for (keys %$searchhash) {
1052             delete $$searchhash{$_}
1053                 unless defined $$searchhash{$_};
1054         }
1055
1056         $result = $U->storagereq( $method, %$searchhash );
1057         $trim = 1;
1058
1059     } else {
1060         $docache = 0;   # results came FROM cache, so we don't write back
1061     }
1062
1063     return {count => 0} unless ($result && $$result[0]);
1064
1065     @recs = @$result;
1066
1067     my $count = ($ismeta) ? $result->[0]->[3] : $result->[0]->[2];
1068
1069     if($docache) {
1070         # If we didn't get this data from the cache, put it into the cache
1071         # then return the correct offset of records
1072         $logger->debug("putting search cache $ckey\n");
1073         put_cache($ckey, $count, \@recs);
1074     }
1075
1076     if($trim) {
1077         # if we have the full set of data, trim out
1078         # the requested chunk based on limit and offset
1079         my @t;
1080         for ($offset..$end) {
1081             last unless $recs[$_];
1082             push(@t, $recs[$_]);
1083         }
1084         @recs = @t;
1085     }
1086
1087     return { ids => \@recs, count => $count };
1088 }
1089
1090
1091 __PACKAGE__->register_method(
1092     method    => 'staged_search',
1093     api_name  => 'open-ils.search.biblio.multiclass.staged',
1094     signature => {
1095         desc   => 'Staged search filters out unavailable items.  This means that it relies on an estimation strategy for determining ' .
1096                   'how big a "raw" search result chunk (i.e. a "superpage") to obtain prior to filtering.  See "estimation_strategy" in your SRF config.',
1097         params => [
1098             {
1099                 desc => "A search hash with keys: "
1100                       . "searches, limit, offset.  The others are optional, but the 'searches' key/value pair is required, with the value being a hashref.  "
1101                       . "See perldoc " . __PACKAGE__ . " for more detail",
1102                 type => 'object',
1103             },
1104             {
1105                 desc => "A flag to enable/disable searching and saving results in cache, including facets (default OFF)",
1106                 type => 'string',
1107             }
1108         ],
1109         return => {
1110             desc => 'Hash with keys: count, core_limit, superpage_size, superpage_summary, facet_key, ids.  '
1111                   . 'The superpage_summary value is a hashref that includes keys: estimated_hit_count, visible.',
1112             type => 'object',
1113         }
1114     }
1115 );
1116 __PACKAGE__->register_method(
1117     method    => 'staged_search',
1118     api_name  => 'open-ils.search.biblio.multiclass.staged.staff',
1119     signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items.  Otherwise, @see open-ils.search.biblio.multiclass.staged/
1120 );
1121 __PACKAGE__->register_method(
1122     method    => 'staged_search',
1123     api_name  => 'open-ils.search.metabib.multiclass.staged',
1124     signature => q/@see open-ils.search.biblio.multiclass.staged/
1125 );
1126 __PACKAGE__->register_method(
1127     method    => 'staged_search',
1128     api_name  => 'open-ils.search.metabib.multiclass.staged.staff',
1129     signature => q/The .staff search includes hidden bibs, hidden items and bibs with no items.  Otherwise, @see open-ils.search.biblio.multiclass.staged/
1130 );
1131
1132 my $estimation_strategy;
1133 sub staged_search {
1134     my($self, $conn, $search_hash, $docache) = @_;
1135
1136     my $IAmMetabib = ($self->api_name =~ /metabib/) ? 1 : 0;
1137
1138     my $method = $IAmMetabib?
1139         'open-ils.storage.metabib.multiclass.staged.search_fts':
1140         'open-ils.storage.biblio.multiclass.staged.search_fts';
1141
1142     $method .= '.staff' if $self->api_name =~ /staff$/;
1143     $method .= '.atomic';
1144
1145     if (!$search_hash->{query}) {
1146         return {count => 0} unless (
1147             $search_hash and
1148             $search_hash->{searches} and
1149             scalar( keys %{$search_hash->{searches}} ));
1150     }
1151
1152     my $search_duration;
1153     my $user_offset = $search_hash->{offset} ||  0; # user-specified offset
1154     my $user_limit  = $search_hash->{limit}  || 10;
1155     my $ignore_facet_classes  = $search_hash->{ignore_facet_classes};
1156     $user_offset = ($user_offset >= 0) ? $user_offset :  0;
1157     $user_limit  = ($user_limit  >= 0) ? $user_limit  : 10;
1158
1159
1160     # we're grabbing results on a per-superpage basis, which means the
1161     # limit and offset should coincide with superpage boundaries
1162     $search_hash->{offset} = 0;
1163     $search_hash->{limit} = $superpage_size;
1164
1165     # force a well-known check_limit
1166     $search_hash->{check_limit} = $superpage_size;
1167     # restrict total tested to superpage size * number of superpages
1168     $search_hash->{core_limit}  = $superpage_size * $max_superpages;
1169
1170     # Set the configured estimation strategy, defaults to 'inclusion'.
1171     unless ($estimation_strategy) {
1172         $estimation_strategy = OpenSRF::Utils::SettingsClient
1173             ->new
1174             ->config_value(
1175                 apps => 'open-ils.search', app_settings => 'estimation_strategy'
1176             ) || 'inclusion';
1177     }
1178     $search_hash->{estimation_strategy} = $estimation_strategy;
1179
1180     # pull any existing results from the cache
1181     my $key = search_cache_key($method, $search_hash);
1182     my $facet_key = $key.'_facets';
1183     my $cache_data = $cache->get_cache($key) || {};
1184
1185     # First, we want to make sure that someone else isn't currently trying to perform exactly
1186     # this same search.  The point is to allow just one instance of a search to fill the needs
1187     # of all concurrent, identical searches.  This will avoid spammy searches killing the
1188     # database without requiring admins to start locking some IP addresses out entirely.
1189     #
1190     # There's still a tiny race condition where 2 might run, but without sigificantly more code
1191     # and complexity, this is close to the best we can do.
1192
1193     if ($cache_data->{running}) { # someone is already doing the search...
1194         my $stop_looping = time() + $cache_timeout;
1195         while ( sleep(1) and time() < $stop_looping ) { # sleep for a second ... maybe they'll finish
1196             $cache_data = $cache->get_cache($key) || {};
1197             last if (!$cache_data->{running});
1198         }
1199     } elsif (!$cache_data->{0}) { # we're the first ... let's give it a try
1200         $cache->put_cache($key, { running => $$ }, $cache_timeout / 3);
1201     }
1202
1203     # keep retrieving results until we find enough to
1204     # fulfill the user-specified limit and offset
1205     my $all_results = [];
1206     my $page; # current superpage
1207     my $current_page_summary = {};
1208     my $global_summary = {checked => 0, visible => 0, excluded => 0, deleted => 0, total => 0};
1209     my $new_ids = [];
1210
1211     for($page = 0; $page < $max_superpages; $page++) {
1212
1213         my $data = $cache_data->{$page};
1214         my $results;
1215         my $summary;
1216
1217         $logger->debug("staged search: analyzing superpage $page");
1218
1219         if($data) {
1220             # this window of results is already cached
1221             $logger->debug("staged search: found cached results");
1222             $summary = $data->{summary};
1223             $results = $data->{results};
1224
1225         } else {
1226             # retrieve the window of results from the database
1227             $logger->debug("staged search: fetching results from the database");
1228             $search_hash->{skip_check} = $page * $superpage_size;
1229             $search_hash->{return_query} = $page == 0 ? 1 : 0;
1230
1231             my $start = time;
1232             $results = $U->storagereq($method, %$search_hash);
1233             $search_duration = time - $start;
1234             $summary = shift(@$results) if $results;
1235
1236             unless($summary) {
1237                 $logger->info("search timed out: duration=$search_duration: params=".
1238                     OpenSRF::Utils::JSON->perl2JSON($search_hash));
1239                 return {count => 0};
1240             }
1241
1242             $logger->info("staged search: DB call took $search_duration seconds and returned ".scalar(@$results)." rows, including summary");
1243
1244             # Create backwards-compatible result structures
1245             if($IAmMetabib) {
1246                 $results = [map {[$_->{id}, $_->{badges}, $_->{popularity}, $_->{rel}, $_->{record}]} @$results];
1247             } else {
1248                 $results = [map {[$_->{id}, $_->{badges}, $_->{popularity}]} @$results];
1249             }
1250
1251             push @$new_ids, grep {defined($_)} map {$_->[0]} @$results;
1252             $results = [grep {defined $_->[0]} @$results];
1253             cache_staged_search_page($key, $page, $summary, $results) if $docache;
1254         }
1255
1256         tag_circulated_records($search_hash->{authtoken}, $results, $IAmMetabib)
1257             if $search_hash->{tag_circulated_records} and $search_hash->{authtoken};
1258
1259         $current_page_summary = $summary;
1260
1261         # add the new set of results to the set under construction
1262         push(@$all_results, @$results);
1263
1264         my $current_count = scalar(@$all_results);
1265
1266         if ($page == 0) { # all summaries are the same, just get the first
1267             for (keys %$summary) {
1268                 $global_summary->{$_} = $summary->{$_};
1269             }
1270         }
1271
1272         # we've found all the possible hits
1273         last if $current_count == $summary->{visible};
1274
1275         # we've found enough results to satisfy the requested limit/offset
1276         last if $current_count >= ($user_limit + $user_offset);
1277
1278         # we've scanned all possible hits
1279         last if($summary->{checked} < $superpage_size);
1280     }
1281
1282     # Let other backends grab our data now that we're done.
1283     $cache_data = $cache->get_cache($key);
1284     if ($$cache_data{running} and $$cache_data{running} == $$) {
1285         delete $$cache_data{running};
1286         $cache->put_cache($key, $cache_data, $cache_timeout);
1287     }
1288
1289     my @results = grep {defined $_} @$all_results[$user_offset..($user_offset + $user_limit - 1)];
1290
1291     $conn->respond_complete(
1292         {
1293             global_summary    => $global_summary,
1294             count             => $global_summary->{visible},
1295             core_limit        => $search_hash->{core_limit},
1296             superpage         => $page,
1297             superpage_size    => $search_hash->{check_limit},
1298             superpage_summary => $current_page_summary,
1299             facet_key         => $facet_key,
1300             ids               => \@results
1301         }
1302     );
1303
1304     $logger->info("Completed canonicalized search is: $$global_summary{canonicalized_query}");
1305
1306     return cache_facets($facet_key, $new_ids, $IAmMetabib, $ignore_facet_classes) if $docache;
1307 }
1308
1309 sub fetch_display_fields {
1310     my $self = shift;
1311     my $conn = shift;
1312     my $highlight_map = shift;
1313     my @records = @_;
1314
1315     unless (@records) {
1316         $conn->respond_complete;
1317         return;
1318     }
1319
1320     my $hl_map_string = "";
1321     if (ref($highlight_map) =~ /HASH/) {
1322         for my $tsq (keys %$highlight_map) {
1323             my $field_list = join(',', @{$$highlight_map{$tsq}});
1324             $hl_map_string .= ' || ' if $hl_map_string;
1325             $hl_map_string .= "hstore(($tsq)\:\:TEXT,'$field_list')";
1326         }
1327     }
1328
1329     my $e = new_editor();
1330
1331     for my $record ( @records ) {
1332         next unless ($record && $hl_map_string);
1333         $conn->respond(
1334             $e->json_query(
1335                 {from => ['search.highlight_display_fields', $record, $hl_map_string]}
1336             )
1337         );
1338     }
1339
1340     return undef;
1341 }
1342 __PACKAGE__->register_method(
1343     method    => 'fetch_display_fields',
1344     api_name  => 'open-ils.search.fetch.metabib.display_field.highlight',
1345     stream   => 1
1346 );
1347
1348
1349 sub tag_circulated_records {
1350     my ($auth, $results, $metabib) = @_;
1351     my $e = new_editor(authtoken => $auth);
1352     return $results unless $e->checkauth;
1353
1354     my $query = {
1355         select   => { acn => [{ column => 'record', alias => 'tagme' }] },
1356         from     => { auch => { acp => { join => 'acn' }} },
1357         where    => { usr => $e->requestor->id },
1358         distinct => 1
1359     };
1360
1361     if ($metabib) {
1362         $query = {
1363             select   => { mmrsm => [{ column => 'metarecord', alias => 'tagme' }] },
1364             from     => 'mmrsm',
1365             where    => { source => { in => $query } },
1366             distinct => 1
1367         };
1368     }
1369
1370     # Give me the distinct set of bib records that exist in the user's visible circulation history
1371     my $circ_recs = $e->json_query( $query );
1372
1373     # if the record appears in the circ history, push a 1 onto
1374     # the rec array structure to indicate truthiness
1375     for my $rec (@$results) {
1376         push(@$rec, 1) if grep { $_->{tagme} eq $$rec[0] } @$circ_recs;
1377     }
1378
1379     $results
1380 }
1381
1382 # creates a unique token to represent the query in the cache
1383 sub search_cache_key {
1384     my $method = shift;
1385     my $search_hash = shift;
1386     my @sorted;
1387     for my $key (sort keys %$search_hash) {
1388         push(@sorted, ($key => $$search_hash{$key}))
1389             unless $key eq 'limit'  or
1390                    $key eq 'offset' or
1391                    $key eq 'skip_check';
1392     }
1393     my $s = OpenSRF::Utils::JSON->perl2JSON(\@sorted);
1394     return $pfx . md5_hex($method . $s);
1395 }
1396
1397 sub retrieve_cached_facets {
1398     my $self   = shift;
1399     my $client = shift;
1400     my $key    = shift;
1401     my $limit    = shift;
1402
1403     return undef unless ($key and $key =~ /_facets$/);
1404
1405     eval {
1406         local $SIG{ALRM} = sub {die};
1407         alarm(10); # we'll sleep for as much as 10s
1408         do {
1409             die if $cache->get_cache($key . '_COMPLETE');
1410         } while (sleep(0.05));
1411         alarm(0);
1412     };
1413     alarm(0);
1414
1415     my $blob = $cache->get_cache($key) || {};
1416
1417     my $facets = {};
1418     if ($limit) {
1419        for my $f ( keys %$blob ) {
1420             my @sorted = map{ { $$_[1] => $$_[0] } } sort {$$b[0] <=> $$a[0] || $$a[1] cmp $$b[1]} map { [$$blob{$f}{$_}, $_] } keys %{ $$blob{$f} };
1421             @sorted = @sorted[0 .. $limit - 1] if (scalar(@sorted) > $limit);
1422             for my $s ( @sorted ) {
1423                 my ($k) = keys(%$s);
1424                 my ($v) = values(%$s);
1425                 $$facets{$f}{$k} = $v;
1426             }
1427         }
1428     } else {
1429         $facets = $blob;
1430     }
1431
1432     return $facets;
1433 }
1434
1435 __PACKAGE__->register_method(
1436     method   => "retrieve_cached_facets",
1437     api_name => "open-ils.search.facet_cache.retrieve",
1438     signature => {
1439         desc   => 'Returns facet data derived from a specific search based on a key '.
1440                   'generated by open-ils.search.biblio.multiclass.staged and friends.',
1441         params => [
1442             {
1443                 desc => "The facet cache key returned with the initial search as the facet_key hash value",
1444                 type => 'string',
1445             }
1446         ],
1447         return => {
1448             desc => 'Two level hash of facet values.  Top level key is the facet id defined on the config.metabib_field table.  '.
1449                     'Second level key is a string facet value.  Datum attached to each facet value is the number of distinct records, '.
1450                     'or metarecords for a metarecord search, which use that facet value and are visible to the search at the time of '.
1451                     'facet retrieval.  These counts are calculated for all superpages that have been checked for visibility.',
1452             type => 'object',
1453         }
1454     }
1455 );
1456
1457
1458 sub cache_facets {
1459     # add facets for this search to the facet cache
1460     my($key, $results, $metabib, $ignore) = @_;
1461     my $data = $cache->get_cache($key);
1462     $data ||= {};
1463
1464     return undef unless (@$results);
1465
1466     my $facets_function = $metabib ? 'search.facets_for_metarecord_set'
1467                                    : 'search.facets_for_record_set';
1468     my $results_str = '{' . join(',', @$results) . '}';
1469     my $ignore_str = ref($ignore) ? '{' . join(',', @$ignore) . '}'
1470                                   : '{}';
1471     my $query = {
1472         from => [ $facets_function, $ignore_str, $results_str ]
1473     };
1474
1475     my $facets = OpenILS::Utils::CStoreEditor->new->json_query($query, {substream => 1});
1476
1477     for my $facet (@$facets) {
1478         next unless ($facet->{value});
1479         $data->{$facet->{id}}->{$facet->{value}} += $facet->{count};
1480     }
1481
1482     $logger->info("facet compilation: cached with key=$key");
1483
1484     $cache->put_cache($key, $data, $cache_timeout);
1485     $cache->put_cache($key.'_COMPLETE', 1, $cache_timeout);
1486 }
1487
1488 sub cache_staged_search_page {
1489     # puts this set of results into the cache
1490     my($key, $page, $summary, $results) = @_;
1491     my $data = $cache->get_cache($key);
1492     $data ||= {};
1493     $data->{$page} = {
1494         summary => $summary,
1495         results => $results
1496     };
1497
1498     $logger->info("staged search: cached with key=$key, superpage=$page, estimated=".
1499         ($summary->{estimated_hit_count} || "none") .
1500         ", visible=" . ($summary->{visible} || "none")
1501     );
1502
1503     $cache->put_cache($key, $data, $cache_timeout);
1504 }
1505
1506 sub search_cache {
1507
1508     my $key     = shift;
1509     my $offset  = shift;
1510     my $limit   = shift;
1511     my $start   = $offset;
1512     my $end     = $offset + $limit - 1;
1513
1514     $logger->debug("searching cache for $key : $start..$end\n");
1515
1516     return undef unless $cache;
1517     my $data = $cache->get_cache($key);
1518
1519     return undef unless $data;
1520
1521     my $count = $data->[0];
1522     $data = $data->[1];
1523
1524     return undef unless $offset < $count;
1525
1526     my @result;
1527     for( my $i = $offset; $i <= $end; $i++ ) {
1528         last unless my $d = $$data[$i];
1529         push( @result, $d );
1530     }
1531
1532     $logger->debug("search_cache found ".scalar(@result)." items for count=$count, start=$start, end=$end");
1533
1534     return \@result;
1535 }
1536
1537
1538 sub put_cache {
1539     my( $key, $count, $data ) = @_;
1540     return undef unless $cache;
1541     $logger->debug("search_cache putting ".
1542         scalar(@$data)." items at key $key with timeout $cache_timeout");
1543     $cache->put_cache($key, [ $count, $data ], $cache_timeout);
1544 }
1545
1546
1547 __PACKAGE__->register_method(
1548     method   => "biblio_mrid_to_modsbatch_batch",
1549     api_name => "open-ils.search.biblio.metarecord.mods_slim.batch.retrieve"
1550 );
1551
1552 sub biblio_mrid_to_modsbatch_batch {
1553     my( $self, $client, $mrids) = @_;
1554     # warn "Performing mrid_to_modsbatch_batch..."; # unconditional warn
1555     my @mods;
1556     my $method = $self->method_lookup("open-ils.search.biblio.metarecord.mods_slim.retrieve");
1557     for my $id (@$mrids) {
1558         next unless defined $id;
1559         my ($m) = $method->run($id);
1560         push @mods, $m;
1561     }
1562     return \@mods;
1563 }
1564
1565
1566 foreach (qw /open-ils.search.biblio.metarecord.mods_slim.retrieve
1567              open-ils.search.biblio.metarecord.mods_slim.retrieve.staff/)
1568     {
1569     __PACKAGE__->register_method(
1570         method    => "biblio_mrid_to_modsbatch",
1571         api_name  => $_,
1572         signature => {
1573             desc   => "Returns the mvr associated with a given metarecod. If none exists, it is created.  "
1574                     . "As usual, the .staff version of this method will include otherwise hidden records.",
1575             params => [
1576                 { desc => 'Metarecord ID', type => 'number' },
1577                 { desc => '(Optional) Search filters hash with possible keys: format, org, depth', type => 'object' }
1578             ],
1579             return => {
1580                 desc => 'MVR Object, event on error',
1581             }
1582         }
1583     );
1584 }
1585
1586 sub biblio_mrid_to_modsbatch {
1587     my( $self, $client, $mrid, $args) = @_;
1588
1589     # warn "Grabbing mvr for $mrid\n";    # unconditional warn
1590
1591     my ($mr, $evt) = _grab_metarecord($mrid);
1592     return $evt unless $mr;
1593
1594     my $mvr = biblio_mrid_check_mvr($self, $client, $mr) ||
1595               biblio_mrid_make_modsbatch($self, $client, $mr);
1596
1597     return $mvr unless ref($args);
1598
1599     # Here we find the lead record appropriate for the given filters
1600     # and use that for the title and author of the metarecord
1601     my $format = $$args{format};
1602     my $org    = $$args{org};
1603     my $depth  = $$args{depth};
1604
1605     return $mvr unless $format or $org or $depth;
1606
1607     my $method = "open-ils.storage.ordered.metabib.metarecord.records";
1608     $method = "$method.staff" if $self->api_name =~ /staff/o;
1609
1610     my $rec = $U->storagereq($method, $format, $org, $depth, 1);
1611
1612     if( my $mods = $U->record_to_mvr($rec) ) {
1613
1614         $mvr->title( $mods->title );
1615         $mvr->author($mods->author);
1616         $logger->debug("mods_slim updating title and ".
1617             "author in mvr with ".$mods->title." : ".$mods->author);
1618     }
1619
1620     return $mvr;
1621 }
1622
1623 # converts a metarecord to an mvr
1624 sub _mr_to_mvr {
1625     my $mr = shift;
1626     my $perl = OpenSRF::Utils::JSON->JSON2perl($mr->mods());
1627     return Fieldmapper::metabib::virtual_record->new($perl);
1628 }
1629
1630 # checks to see if a metarecord has mods, if so returns true;
1631
1632 __PACKAGE__->register_method(
1633     method   => "biblio_mrid_check_mvr",
1634     api_name => "open-ils.search.biblio.metarecord.mods_slim.check",
1635     notes    => "Takes a metarecord ID or a metarecord object and returns true "
1636               . "if the metarecord already has an mvr associated with it."
1637 );
1638
1639 sub biblio_mrid_check_mvr {
1640     my( $self, $client, $mrid ) = @_;
1641     my $mr;
1642
1643     my $evt;
1644     if(ref($mrid)) { $mr = $mrid; }
1645     else { ($mr, $evt) = _grab_metarecord($mrid); }
1646     return $evt if $evt;
1647
1648     # warn "Checking mvr for mr " . $mr->id . "\n";   # unconditional warn
1649
1650     return _mr_to_mvr($mr) if $mr->mods();
1651     return undef;
1652 }
1653
1654 sub _grab_metarecord {
1655     my $mrid = shift;
1656     my $e = new_editor();
1657     my $mr = $e->retrieve_metabib_metarecord($mrid) or return ( undef, $e->event );
1658     return ($mr);
1659 }
1660
1661
1662 __PACKAGE__->register_method(
1663     method   => "biblio_mrid_make_modsbatch",
1664     api_name => "open-ils.search.biblio.metarecord.mods_slim.create",
1665     notes    => "Takes either a metarecord ID or a metarecord object. "
1666               . "Forces the creations of an mvr for the given metarecord. "
1667               . "The created mvr is returned."
1668 );
1669
1670 sub biblio_mrid_make_modsbatch {
1671     my( $self, $client, $mrid ) = @_;
1672
1673     my $e = new_editor();
1674
1675     my $mr;
1676     if( ref($mrid) ) {
1677         $mr = $mrid;
1678         $mrid = $mr->id;
1679     } else {
1680         $mr = $e->retrieve_metabib_metarecord($mrid)
1681             or return $e->event;
1682     }
1683
1684     my $masterid = $mr->master_record;
1685     $logger->info("creating new mods batch for metarecord=$mrid, master record=$masterid");
1686
1687     my $ids = $U->storagereq(
1688         'open-ils.storage.ordered.metabib.metarecord.records.staff.atomic', $mrid);
1689     return undef unless @$ids;
1690
1691     my $master = $e->retrieve_biblio_record_entry($masterid)
1692         or return $e->event;
1693
1694     # start the mods batch
1695     my $u = OpenILS::Utils::ModsParser->new();
1696     $u->start_mods_batch( $master->marc );
1697
1698     # grab all of the sub-records and shove them into the batch
1699     my @ids = grep { $_ ne $masterid } @$ids;
1700     #my $subrecs = (@ids) ? $e->batch_retrieve_biblio_record_entry(\@ids) : [];
1701
1702     my $subrecs = [];
1703     if(@$ids) {
1704         for my $i (@$ids) {
1705             my $r = $e->retrieve_biblio_record_entry($i);
1706             push( @$subrecs, $r ) if $r;
1707         }
1708     }
1709
1710     for(@$subrecs) {
1711         $logger->debug("adding record ".$_->id." to mods batch for metarecord=$mrid");
1712         $u->push_mods_batch( $_->marc ) if $_->marc;
1713     }
1714
1715
1716     # finish up and send to the client
1717     my $mods = $u->finish_mods_batch();
1718     $mods->doc_id($mrid);
1719     $client->respond_complete($mods);
1720
1721
1722     # now update the mods string in the db
1723     my $string = OpenSRF::Utils::JSON->perl2JSON($mods->decast);
1724     $mr->mods($string);
1725
1726     $e = new_editor(xact => 1);
1727     $e->update_metabib_metarecord($mr)
1728         or $logger->error("Error setting mods text on metarecord $mrid : " . Dumper($e->event));
1729     $e->finish;
1730
1731     return undef;
1732 }
1733
1734
1735 # converts a mr id into a list of record ids
1736
1737 foreach (qw/open-ils.search.biblio.metarecord_to_records
1738             open-ils.search.biblio.metarecord_to_records.staff/)
1739 {
1740     __PACKAGE__->register_method(
1741         method    => "biblio_mrid_to_record_ids",
1742         api_name  => $_,
1743         signature => {
1744             desc   => "Fetch record IDs corresponding to a meta-record ID, with optional search filters. "
1745                     . "As usual, the .staff version of this method will include otherwise hidden records.",
1746             params => [
1747                 { desc => 'Metarecord ID', type => 'number' },
1748                 { desc => '(Optional) Search filters hash with possible keys: format, org, depth', type => 'object' }
1749             ],
1750             return => {
1751                 desc => 'Results object like {count => $i, ids =>[...]}',
1752                 type => 'object'
1753             }
1754
1755         }
1756     );
1757 }
1758
1759 sub biblio_mrid_to_record_ids {
1760     my( $self, $client, $mrid, $args ) = @_;
1761
1762     my $format = $$args{format};
1763     my $org    = $$args{org};
1764     my $depth  = $$args{depth};
1765
1766     my $method = "open-ils.storage.ordered.metabib.metarecord.records.atomic";
1767     $method =~ s/atomic/staff\.atomic/o if $self->api_name =~ /staff/o;
1768     my $recs = $U->storagereq($method, $mrid, $format, $org, $depth);
1769
1770     return { count => scalar(@$recs), ids => $recs };
1771 }
1772
1773
1774 __PACKAGE__->register_method(
1775     method   => "biblio_record_to_marc_html",
1776     api_name => "open-ils.search.biblio.record.html"
1777 );
1778
1779 __PACKAGE__->register_method(
1780     method   => "biblio_record_to_marc_html",
1781     api_name => "open-ils.search.authority.to_html"
1782 );
1783
1784 # Persistent parsers and setting objects
1785 my $parser = XML::LibXML->new();
1786 my $xslt   = XML::LibXSLT->new();
1787 my $marc_sheet;
1788 my $slim_marc_sheet;
1789 my $settings_client = OpenSRF::Utils::SettingsClient->new();
1790
1791 sub biblio_record_to_marc_html {
1792     my($self, $client, $recordid, $slim, $marcxml) = @_;
1793
1794     my $sheet;
1795     my $dir = $settings_client->config_value("dirs", "xsl");
1796
1797     if($slim) {
1798         unless($slim_marc_sheet) {
1799             my $xsl = $settings_client->config_value(
1800                 "apps", "open-ils.search", "app_settings", 'marc_html_xsl_slim');
1801             if($xsl) {
1802                 $xsl = $parser->parse_file("$dir/$xsl");
1803                 $slim_marc_sheet = $xslt->parse_stylesheet($xsl);
1804             }
1805         }
1806         $sheet = $slim_marc_sheet;
1807     }
1808
1809     unless($sheet) {
1810         unless($marc_sheet) {
1811             my $xsl_key = ($slim) ? 'marc_html_xsl_slim' : 'marc_html_xsl';
1812             my $xsl = $settings_client->config_value(
1813                 "apps", "open-ils.search", "app_settings", 'marc_html_xsl');
1814             $xsl = $parser->parse_file("$dir/$xsl");
1815             $marc_sheet = $xslt->parse_stylesheet($xsl);
1816         }
1817         $sheet = $marc_sheet;
1818     }
1819
1820     my $record;
1821     unless($marcxml) {
1822         my $e = new_editor();
1823         if($self->api_name =~ /authority/) {
1824             $record = $e->retrieve_authority_record_entry($recordid)
1825                 or return $e->event;
1826         } else {
1827             $record = $e->retrieve_biblio_record_entry($recordid)
1828                 or return $e->event;
1829         }
1830         $marcxml = $record->marc;
1831     }
1832
1833     my $xmldoc = $parser->parse_string($marcxml);
1834     my $html = $sheet->transform($xmldoc);
1835     return $html->documentElement->toString();
1836 }
1837
1838 __PACKAGE__->register_method(
1839     method    => "format_biblio_record_entry",
1840     api_name  => "open-ils.search.biblio.record.print",
1841     signature => {
1842         desc   => 'Returns a printable version of the specified bib record',
1843         params => [
1844             { desc => 'Biblio record entry ID or array of IDs', type => 'number' },
1845         ],
1846         return => {
1847             desc => q/An action_trigger.event object or error event./,
1848             type => 'object',
1849         }
1850     }
1851 );
1852 __PACKAGE__->register_method(
1853     method    => "format_biblio_record_entry",
1854     api_name  => "open-ils.search.biblio.record.email",
1855     signature => {
1856         desc   => 'Emails an A/T templated version of the specified bib records to the authorized user',
1857         params => [
1858             { desc => 'Authentication token',  type => 'string'},
1859             { desc => 'Biblio record entry ID or array of IDs', type => 'number' },
1860         ],
1861         return => {
1862             desc => q/Undefined on success, otherwise an error event./,
1863             type => 'object',
1864         }
1865     }
1866 );
1867
1868 sub format_biblio_record_entry {
1869     my($self, $conn, $arg1, $arg2) = @_;
1870
1871     my $for_print = ($self->api_name =~ /print/);
1872     my $for_email = ($self->api_name =~ /email/);
1873
1874     my $e; my $auth; my $bib_id; my $context_org;
1875
1876     if ($for_print) {
1877         $bib_id = $arg1;
1878         $context_org = $arg2 || $U->get_org_tree->id;
1879         $e = new_editor(xact => 1);
1880     } elsif ($for_email) {
1881         $auth = $arg1;
1882         $bib_id = $arg2;
1883         $e = new_editor(authtoken => $auth, xact => 1);
1884         return $e->die_event unless $e->checkauth;
1885         $context_org = $e->requestor->home_ou;
1886     }
1887
1888     my $bib_ids;
1889     if (ref $bib_id ne 'ARRAY') {
1890         $bib_ids = [ $bib_id ];
1891     } else {
1892         $bib_ids = $bib_id;
1893     }
1894
1895     my $bucket = Fieldmapper::container::biblio_record_entry_bucket->new;
1896     $bucket->btype('temp');
1897     $bucket->name('format_biblio_record_entry ' . $U->create_uuid_string);
1898     if ($for_email) {
1899         $bucket->owner($e->requestor)
1900     } else {
1901         $bucket->owner(1);
1902     }
1903     my $bucket_obj = $e->create_container_biblio_record_entry_bucket($bucket);
1904
1905     for my $id (@$bib_ids) {
1906
1907         my $bib = $e->retrieve_biblio_record_entry([$id]) or return $e->die_event;
1908
1909         my $bucket_entry = Fieldmapper::container::biblio_record_entry_bucket_item->new;
1910         $bucket_entry->target_biblio_record_entry($bib);
1911         $bucket_entry->bucket($bucket_obj->id);
1912         $e->create_container_biblio_record_entry_bucket_item($bucket_entry);
1913     }
1914
1915     $e->commit;
1916
1917     if ($for_print) {
1918
1919         return $U->fire_object_event(undef, 'biblio.format.record_entry.print', [ $bucket ], $context_org);
1920
1921     } elsif ($for_email) {
1922
1923         $U->create_events_for_hook('biblio.format.record_entry.email', $bucket, $context_org, undef, undef, 1);
1924     }
1925
1926     return undef;
1927 }
1928
1929
1930 __PACKAGE__->register_method(
1931     method   => "retrieve_all_copy_statuses",
1932     api_name => "open-ils.search.config.copy_status.retrieve.all"
1933 );
1934
1935 sub retrieve_all_copy_statuses {
1936     my( $self, $client ) = @_;
1937     return new_editor()->retrieve_all_config_copy_status();
1938 }
1939
1940
1941 __PACKAGE__->register_method(
1942     method   => "copy_counts_per_org",
1943     api_name => "open-ils.search.biblio.copy_counts.retrieve"
1944 );
1945
1946 __PACKAGE__->register_method(
1947     method   => "copy_counts_per_org",
1948     api_name => "open-ils.search.biblio.copy_counts.retrieve.staff"
1949 );
1950
1951 sub copy_counts_per_org {
1952     my( $self, $client, $record_id ) = @_;
1953
1954     warn "Retreiveing copy copy counts for record $record_id and method " . $self->api_name . "\n";
1955
1956     my $method = "open-ils.storage.biblio.record_entry.global_copy_count.atomic";
1957     if($self->api_name =~ /staff/) { $method =~ s/atomic/staff\.atomic/; }
1958
1959     my $counts = $apputils->simple_scalar_request(
1960         "open-ils.storage", $method, $record_id );
1961
1962     $counts = [ sort {$a->[0] <=> $b->[0]} @$counts ];
1963     return $counts;
1964 }
1965
1966
1967 __PACKAGE__->register_method(
1968     method   => "copy_count_summary",
1969     api_name => "open-ils.search.biblio.copy_counts.summary.retrieve",
1970     notes    => "returns an array of these: "
1971               . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, <status1_count>, <status2_count>,...] "
1972               . "where statusx is a copy status name.  The statuses are sorted by ID.",
1973 );
1974
1975
1976 sub copy_count_summary {
1977     my( $self, $client, $rid, $org, $depth ) = @_;
1978     $org   ||= 1;
1979     $depth ||= 0;
1980     my $data = $U->storagereq(
1981         'open-ils.storage.biblio.record_entry.status_copy_count.atomic', $rid, $org, $depth );
1982
1983     return [ sort {
1984         (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
1985         cmp
1986         (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
1987     } @$data ];
1988 }
1989
1990 __PACKAGE__->register_method(
1991     method   => "copy_location_count_summary",
1992     api_name => "open-ils.search.biblio.copy_location_counts.summary.retrieve",
1993     notes    => "returns an array of these: "
1994               . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, copy_location, <status1_count>, <status2_count>,...] "
1995               . "where statusx is a copy status name.  The statuses are sorted by ID.",
1996 );
1997
1998 sub copy_location_count_summary {
1999     my( $self, $client, $rid, $org, $depth ) = @_;
2000     $org   ||= 1;
2001     $depth ||= 0;
2002     my $data = $U->storagereq(
2003         'open-ils.storage.biblio.record_entry.status_copy_location_count.atomic', $rid, $org, $depth );
2004
2005     return [ sort {
2006         (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2007         cmp
2008         (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2009
2010         || $a->[4] cmp $b->[4]
2011     } @$data ];
2012 }
2013
2014 __PACKAGE__->register_method(
2015     method   => "copy_count_location_summary",
2016     api_name => "open-ils.search.biblio.copy_counts.location.summary.retrieve",
2017     notes    => "returns an array of these: "
2018               . "[ org_id, callnumber_prefix, callnumber_label, callnumber_suffix, <status1_count>, <status2_count>,...] "
2019               . "where statusx is a copy status name.  The statuses are sorted by ID."
2020 );
2021
2022 sub copy_count_location_summary {
2023     my( $self, $client, $rid, $org, $depth ) = @_;
2024     $org   ||= 1;
2025     $depth ||= 0;
2026     my $data = $U->storagereq(
2027         'open-ils.storage.biblio.record_entry.status_copy_location_count.atomic', $rid, $org, $depth );
2028     return [ sort {
2029         (($a->[1] ? $a->[1] . ' ' : '') . $a->[2] . ($a->[3] ? ' ' . $a->[3] : ''))
2030         cmp
2031         (($b->[1] ? $b->[1] . ' ' : '') . $b->[2] . ($b->[3] ? ' ' . $b->[3] : ''))
2032     } @$data ];
2033 }
2034
2035
2036 foreach (qw/open-ils.search.biblio.marc
2037             open-ils.search.biblio.marc.staff/)
2038 {
2039 __PACKAGE__->register_method(
2040     method    => "marc_search",
2041     api_name  => $_,
2042     signature => {
2043         desc   => 'Fetch biblio IDs based on MARC record criteria.  '
2044                 . 'As usual, the .staff version of the search includes otherwise hidden records',
2045         params => [
2046             {
2047                 desc => 'Search hash (required) with possible elements: searches, limit, offset, sort, sort_dir. ' .
2048                         'See perldoc ' . __PACKAGE__ . ' for more detail.',
2049                 type => 'object'
2050             },
2051             {desc => 'timeout (optional)',  type => 'number'}
2052         ],
2053         return => {
2054             desc => 'Results object like: { "count": $i, "ids": [...] }',
2055             type => 'object'
2056         }
2057     }
2058 );
2059 }
2060
2061 =head3 open-ils.search.biblio.marc (arghash, timeout)
2062
2063 As elsewhere the arghash is the required argument, and must be a hashref.  The keys are:
2064
2065     searches: complex query object  (required)
2066     org_unit: The org ID to focus the search at
2067     depth   : The org depth
2068     limit   : integer search limit      default: 10
2069     offset  : integer search offset     default:  0
2070     sort    : What field to sort the results on? [ author | title | pubdate ]
2071     sort_dir: In what direction do we sort? [ asc | desc ]
2072
2073 Additional keys to refine search criteria:
2074
2075     audience : Audience
2076     language : Language (code)
2077     lit_form : Literary form
2078     item_form: Item form
2079     item_type: Item type
2080     format   : The MARC format
2081
2082 Please note that the specific strings to be used in the "addtional keys" will be entirely
2083 dependent on your loaded data.
2084
2085 All keys except "searches" are optional.
2086 The "searches" value must be an arrayref of hashref elements, including keys "term" and "restrict".
2087
2088 For example, an arg hash might look like:
2089
2090     $arghash = {
2091         searches => [
2092             {
2093                 term     => "harry",
2094                 restrict => [
2095                     {
2096                         tag => 245,
2097                         subfield => "a"
2098                     }
2099                     # ...
2100                 ]
2101             }
2102             # ...
2103         ],
2104         org_unit  => 1,
2105         limit     => 5,
2106         sort      => "author",
2107         item_type => "g"
2108     }
2109
2110 The arghash is eventually passed to the SRF call:
2111 L<open-ils.storage.biblio.full_rec.multi_search[.staff].atomic>
2112
2113 Presently, search uses the cache unconditionally.
2114
2115 =cut
2116
2117 # FIXME: that example above isn't actually tested.
2118 # FIXME: sort and limit added.  item_type not tested yet.
2119 # TODO: docache option?
2120 sub marc_search {
2121     my( $self, $conn, $args, $timeout ) = @_;
2122
2123     my $method = 'open-ils.storage.biblio.full_rec.multi_search';
2124     $method .= ".staff" if $self->api_name =~ /staff/;
2125     $method .= ".atomic";
2126
2127     my $limit = $args->{limit} || 10;
2128     my $offset = $args->{offset} || 0;
2129
2130     # allow caller to pass in a call timeout since MARC searches
2131     # can take longer than the default 60-second timeout.
2132     # Default to 2 mins.  Arbitrarily cap at 5 mins.
2133     $timeout = 120 if !$timeout or $timeout > 300;
2134
2135     my @search;
2136     push( @search, ($_ => $$args{$_}) ) for (sort keys %$args);
2137     my $ckey = $pfx . md5_hex($method . OpenSRF::Utils::JSON->perl2JSON(\@search));
2138
2139     my $recs = search_cache($ckey, $offset, $limit);
2140
2141     if(!$recs) {
2142
2143         my $ses = OpenSRF::AppSession->create('open-ils.storage');
2144         my $req = $ses->request($method, %$args);
2145         my $resp = $req->recv($timeout);
2146
2147         if($resp and $recs = $resp->content) {
2148             put_cache($ckey, scalar(@$recs), $recs);
2149         } else {
2150             $recs = [];
2151         }
2152
2153         $ses->kill_me;
2154     }
2155
2156     my $count = 0;
2157     $count = $recs->[0]->[2] if $recs->[0] and $recs->[0]->[2];
2158     my @recs = map { $_->[0] } @$recs;
2159
2160     return { ids => \@recs, count => $count };
2161 }
2162
2163
2164 foreach my $isbn_method (qw/
2165     open-ils.search.biblio.isbn
2166     open-ils.search.biblio.isbn.staff
2167 /) {
2168 __PACKAGE__->register_method(
2169     method    => "biblio_search_isbn",
2170     api_name  => $isbn_method,
2171     signature => {
2172         desc   => 'Retrieve biblio IDs for a given ISBN. The .staff version of the call includes otherwise hidden hits.',
2173         params => [
2174             {desc => 'ISBN', type => 'string'}
2175         ],
2176         return => {
2177             desc => 'Results object like: { "count": $i, "ids": [...] }',
2178             type => 'object'
2179         }
2180     }
2181 );
2182 }
2183
2184 sub biblio_search_isbn {
2185     my( $self, $client, $isbn ) = @_;
2186     $logger->debug("Searching ISBN $isbn");
2187     # the previous implementation of this method was essentially unlimited,
2188     # so we will set our limit very high and let multiclass.query provide any
2189     # actual limit
2190     # XXX: if making this unlimited is deemed important, we might consider
2191     # reworking 'open-ils.storage.id_list.biblio.record_entry.search.isbn',
2192     # which is functionally deprecated at this point, or a custom call to
2193     # 'open-ils.storage.biblio.multiclass.search_fts'
2194
2195     my $isbn_method = 'open-ils.search.biblio.multiclass.query';
2196     if ($self->api_name =~ m/.staff$/) {
2197         $isbn_method .= '.staff';
2198     }
2199
2200     my $method = $self->method_lookup($isbn_method);
2201     my ($search_result) = $method->run({'limit' => 1000000}, "identifier|isbn:$isbn");
2202     my @recs = map { $_->[0] } @{$search_result->{'ids'}};
2203     return { ids => \@recs, count => $search_result->{'count'} };
2204 }
2205
2206 __PACKAGE__->register_method(
2207     method   => "biblio_search_isbn_batch",
2208     api_name => "open-ils.search.biblio.isbn_list",
2209 );
2210
2211 # XXX: see biblio_search_isbn() for note concerning 'limit'
2212 sub biblio_search_isbn_batch {
2213     my( $self, $client, $isbn_list ) = @_;
2214     $logger->debug("Searching ISBNs @$isbn_list");
2215     my @recs = (); my %rec_set = ();
2216     my $method = $self->method_lookup('open-ils.search.biblio.multiclass.query');
2217     foreach my $isbn ( @$isbn_list ) {
2218         my ($search_result) = $method->run({'limit' => 1000000}, "identifier|isbn:$isbn");
2219         my @recs_subset = map { $_->[0] } @{$search_result->{'ids'}};
2220         foreach my $rec (@recs_subset) {
2221             if (! $rec_set{ $rec }) {
2222                 $rec_set{ $rec } = 1;
2223                 push @recs, $rec;
2224             }
2225         }
2226     }
2227     return { ids => \@recs, count => scalar(@recs) };
2228 }
2229
2230 foreach my $issn_method (qw/
2231     open-ils.search.biblio.issn
2232     open-ils.search.biblio.issn.staff
2233 /) {
2234 __PACKAGE__->register_method(
2235     method   => "biblio_search_issn",
2236     api_name => $issn_method,
2237     signature => {
2238         desc   => 'Retrieve biblio IDs for a given ISSN',
2239         params => [
2240             {desc => 'ISBN', type => 'string'}
2241         ],
2242         return => {
2243             desc => 'Results object like: { "count": $i, "ids": [...] }',
2244             type => 'object'
2245         }
2246     }
2247 );
2248 }
2249
2250 sub biblio_search_issn {
2251     my( $self, $client, $issn ) = @_;
2252     $logger->debug("Searching ISSN $issn");
2253     # the previous implementation of this method was essentially unlimited,
2254     # so we will set our limit very high and let multiclass.query provide any
2255     # actual limit
2256     # XXX: if making this unlimited is deemed important, we might consider
2257     # reworking 'open-ils.storage.id_list.biblio.record_entry.search.issn',
2258     # which is functionally deprecated at this point, or a custom call to
2259     # 'open-ils.storage.biblio.multiclass.search_fts'
2260
2261     my $issn_method = 'open-ils.search.biblio.multiclass.query';
2262     if ($self->api_name =~ m/.staff$/) {
2263         $issn_method .= '.staff';
2264     }
2265
2266     my $method = $self->method_lookup($issn_method);
2267     my ($search_result) = $method->run({'limit' => 1000000}, "identifier|issn:$issn");
2268     my @recs = map { $_->[0] } @{$search_result->{'ids'}};
2269     return { ids => \@recs, count => $search_result->{'count'} };
2270 }
2271
2272
2273 __PACKAGE__->register_method(
2274     method    => "fetch_mods_by_copy",
2275     api_name  => "open-ils.search.biblio.mods_from_copy",
2276     argc      => 1,
2277     signature => {
2278         desc    => 'Retrieve MODS record given an attached copy ID',
2279         params  => [
2280             { desc => 'Copy ID', type => 'number' }
2281         ],
2282         returns => {
2283             desc => 'MODS record, event on error or uncataloged item'
2284         }
2285     }
2286 );
2287
2288 sub fetch_mods_by_copy {
2289     my( $self, $client, $copyid ) = @_;
2290     my ($record, $evt) = $apputils->fetch_record_by_copy( $copyid );
2291     return $evt if $evt;
2292     return OpenILS::Event->new('ITEM_NOT_CATALOGED') unless $record->marc;
2293     return $apputils->record_to_mvr($record);
2294 }
2295
2296
2297 # -------------------------------------------------------------------------------------
2298
2299 __PACKAGE__->register_method(
2300     method   => "cn_browse",
2301     api_name => "open-ils.search.callnumber.browse.target",
2302     notes    => "Starts a callnumber browse"
2303 );
2304
2305 __PACKAGE__->register_method(
2306     method   => "cn_browse",
2307     api_name => "open-ils.search.callnumber.browse.page_up",
2308     notes    => "Returns the previous page of callnumbers",
2309 );
2310
2311 __PACKAGE__->register_method(
2312     method   => "cn_browse",
2313     api_name => "open-ils.search.callnumber.browse.page_down",
2314     notes    => "Returns the next page of callnumbers",
2315 );
2316
2317
2318 # RETURNS array of arrays like so: label, owning_lib, record, id
2319 sub cn_browse {
2320     my( $self, $client, @params ) = @_;
2321     my $method;
2322
2323     $method = 'open-ils.storage.asset.call_number.browse.target.atomic'
2324         if( $self->api_name =~ /target/ );
2325     $method = 'open-ils.storage.asset.call_number.browse.page_up.atomic'
2326         if( $self->api_name =~ /page_up/ );
2327     $method = 'open-ils.storage.asset.call_number.browse.page_down.atomic'
2328         if( $self->api_name =~ /page_down/ );
2329
2330     return $apputils->simplereq( 'open-ils.storage', $method, @params );
2331 }
2332 # -------------------------------------------------------------------------------------
2333
2334 __PACKAGE__->register_method(
2335     method        => "fetch_cn",
2336     api_name      => "open-ils.search.callnumber.retrieve",
2337     authoritative => 1,
2338     notes         => "retrieves a callnumber based on ID",
2339 );
2340
2341 sub fetch_cn {
2342     my( $self, $client, $id ) = @_;
2343
2344     my $e = new_editor();
2345     my( $cn, $evt ) = $apputils->fetch_callnumber( $id, 0, $e );
2346     return $evt if $evt;
2347     return $cn;
2348 }
2349
2350 __PACKAGE__->register_method(
2351     method        => "fetch_fleshed_cn",
2352     api_name      => "open-ils.search.callnumber.fleshed.retrieve",
2353     authoritative => 1,
2354     notes         => "retrieves a callnumber based on ID, fleshing prefix, suffix, and label_class",
2355 );
2356
2357 sub fetch_fleshed_cn {
2358     my( $self, $client, $id ) = @_;
2359
2360     my $e = new_editor();
2361     my( $cn, $evt ) = $apputils->fetch_callnumber( $id, 1, $e );
2362     return $evt if $evt;
2363     return $cn;
2364 }
2365
2366
2367 __PACKAGE__->register_method(
2368     method    => "fetch_copy_by_cn",
2369     api_name  => 'open-ils.search.copies_by_call_number.retrieve',
2370     signature => q/
2371         Returns an array of copy ID's by callnumber ID
2372         @param cnid The callnumber ID
2373         @return An array of copy IDs
2374     /
2375 );
2376
2377 sub fetch_copy_by_cn {
2378     my( $self, $conn, $cnid ) = @_;
2379     return $U->cstorereq(
2380         'open-ils.cstore.direct.asset.copy.id_list.atomic',
2381         { call_number => $cnid, deleted => 'f' } );
2382 }
2383
2384 __PACKAGE__->register_method(
2385     method    => 'fetch_cn_by_info',
2386     api_name  => 'open-ils.search.call_number.retrieve_by_info',
2387     signature => q/
2388         @param label The callnumber label
2389         @param record The record the cn is attached to
2390         @param org The owning library of the cn
2391         @return The callnumber object
2392     /
2393 );
2394
2395
2396 sub fetch_cn_by_info {
2397     my( $self, $conn, $label, $record, $org ) = @_;
2398     return $U->cstorereq(
2399         'open-ils.cstore.direct.asset.call_number.search',
2400         { label => $label, record => $record, owning_lib => $org, deleted => 'f' });
2401 }
2402
2403
2404
2405 __PACKAGE__->register_method(
2406     method   => 'bib_extras',
2407     api_name => 'open-ils.search.biblio.lit_form_map.retrieve.all',
2408     ctype => 'lit_form'
2409 );
2410 __PACKAGE__->register_method(
2411     method   => 'bib_extras',
2412     api_name => 'open-ils.search.biblio.item_form_map.retrieve.all',
2413     ctype => 'item_form'
2414 );
2415 __PACKAGE__->register_method(
2416     method   => 'bib_extras',
2417     api_name => 'open-ils.search.biblio.item_type_map.retrieve.all',
2418     ctype => 'item_type',
2419 );
2420 __PACKAGE__->register_method(
2421     method   => 'bib_extras',
2422     api_name => 'open-ils.search.biblio.bib_level_map.retrieve.all',
2423     ctype => 'bib_level'
2424 );
2425 __PACKAGE__->register_method(
2426     method   => 'bib_extras',
2427     api_name => 'open-ils.search.biblio.audience_map.retrieve.all',
2428     ctype => 'audience'
2429 );
2430
2431 sub bib_extras {
2432     my $self = shift;
2433     $logger->warn("deprecation warning: " .$self->api_name);
2434
2435     my $e = new_editor();
2436
2437     my $ctype = $self->{ctype};
2438     my $ccvms = $e->search_config_coded_value_map({ctype => $ctype});
2439
2440     my @objs;
2441     for my $ccvm (@$ccvms) {
2442         my $obj = "Fieldmapper::config::${ctype}_map"->new;
2443         $obj->value($ccvm->value);
2444         $obj->code($ccvm->code);
2445         $obj->description($ccvm->description) if $obj->can('description');
2446         push(@objs, $obj);
2447     }
2448
2449     return \@objs;
2450 }
2451
2452
2453
2454 __PACKAGE__->register_method(
2455     method    => 'fetch_slim_record',
2456     api_name  => 'open-ils.search.biblio.record_entry.slim.retrieve',
2457     signature => {
2458         desc   => "Retrieves one or more biblio.record_entry without the attached marcxml",
2459         params => [
2460             { desc => 'Array of Record IDs', type => 'array' }
2461         ],
2462         return => {
2463             desc => 'Array of biblio records, event on error'
2464         }
2465     }
2466 );
2467
2468 sub fetch_slim_record {
2469     my( $self, $conn, $ids ) = @_;
2470
2471     my $editor = new_editor();
2472     my @res;
2473     for( @$ids ) {
2474         return $editor->event unless
2475             my $r = $editor->retrieve_biblio_record_entry($_);
2476         $r->clear_marc;
2477         push(@res, $r);
2478     }
2479     return \@res;
2480 }
2481
2482 __PACKAGE__->register_method(
2483     method    => 'rec_hold_parts',
2484     api_name  => 'open-ils.search.biblio.record_hold_parts',
2485     signature => q/
2486        Returns a list of {label :foo, id : bar} objects for viable monograph parts for a given record
2487     /
2488 );
2489
2490 sub rec_hold_parts {
2491     my( $self, $conn, $args ) = @_;
2492
2493     my $rec        = $$args{record};
2494     my $mrec       = $$args{metarecord};
2495     my $pickup_lib = $$args{pickup_lib};
2496     my $e = new_editor();
2497
2498     my $query = {
2499         select => {bmp => ['id', 'label']},
2500         from => 'bmp',
2501         where => {
2502             id => {
2503                 in => {
2504                     select => {'acpm' => ['part']},
2505                     from => {acpm => {acp => {join => {acn => {join => 'bre'}}}}},
2506                     where => {
2507                         '+acp' => {'deleted' => 'f'},
2508                         '+bre' => {id => $rec}
2509                     },
2510                     distinct => 1,
2511                 }
2512             },
2513             deleted => 'f'
2514         },
2515         order_by =>[{class=>'bmp', field=>'label_sortkey'}]
2516     };
2517
2518     if(defined $pickup_lib) {
2519         my $hard_boundary = $U->ou_ancestor_setting_value($pickup_lib, OILS_SETTING_HOLD_HARD_BOUNDARY);
2520         if($hard_boundary) {
2521             my $orgs = $e->json_query({from => ['actor.org_unit_descendants' => $pickup_lib, $hard_boundary]});
2522             $query->{where}->{'+acp'}->{circ_lib} = [ map { $_->{id} } @$orgs ];
2523         }
2524     }
2525
2526     return $e->json_query($query);
2527 }
2528
2529
2530
2531
2532 __PACKAGE__->register_method(
2533     method    => 'rec_to_mr_rec_descriptors',
2534     api_name  => 'open-ils.search.metabib.record_to_descriptors',
2535     signature => q/
2536         specialized method...
2537         Given a biblio record id or a metarecord id,
2538         this returns a list of metabib.record_descriptor
2539         objects that live within the same metarecord
2540         @param args Object of args including:
2541     /
2542 );
2543
2544 sub rec_to_mr_rec_descriptors {
2545     my( $self, $conn, $args ) = @_;
2546
2547     my $rec        = $$args{record};
2548     my $mrec       = $$args{metarecord};
2549     my $item_forms = $$args{item_forms};
2550     my $item_types = $$args{item_types};
2551     my $item_lang  = $$args{item_lang};
2552     my $pickup_lib = $$args{pickup_lib};
2553
2554     my $hard_boundary = $U->ou_ancestor_setting_value($pickup_lib, OILS_SETTING_HOLD_HARD_BOUNDARY) if (defined $pickup_lib);
2555
2556     my $e = new_editor();
2557     my $recs;
2558
2559     if( !$mrec ) {
2560         my $map = $e->search_metabib_metarecord_source_map({source => $rec});
2561         return $e->event unless @$map;
2562         $mrec = $$map[0]->metarecord;
2563     }
2564
2565     $recs = $e->search_metabib_metarecord_source_map({metarecord => $mrec});
2566     return $e->event unless @$recs;
2567
2568     my @recs = map { $_->source } @$recs;
2569     my $search = { record => \@recs };
2570     $search->{item_form} = $item_forms if $item_forms and @$item_forms;
2571     $search->{item_type} = $item_types if $item_types and @$item_types;
2572     $search->{item_lang} = $item_lang  if $item_lang;
2573
2574     my $desc = $e->search_metabib_record_descriptor($search);
2575
2576     my $query = {
2577         distinct => 1,
2578         select   => { 'bre' => ['id'] },
2579         from     => {
2580             'bre' => {
2581                 'acn' => {
2582                     'join' => {
2583                         'acp' => {"join" => {"acpl" => {}, "ccs" => {}}}
2584                       }
2585                   }
2586              }
2587         },
2588         where => {
2589             '+bre' => { id => \@recs },
2590             '+acp' => {
2591                 holdable => 't',
2592                 deleted  => 'f'
2593             },
2594             "+ccs" => { holdable => 't' },
2595             "+acpl" => { holdable => 't', deleted => 'f' }
2596         }
2597     };
2598
2599     if ($hard_boundary) { # 0 (or "top") is the same as no setting
2600         my $orgs = $e->json_query(
2601             { from => [ 'actor.org_unit_descendants' => $pickup_lib, $hard_boundary ] }
2602         ) or return $e->die_event;
2603
2604         $query->{where}->{"+acp"}->{circ_lib} = [ map { $_->{id} } @$orgs ];
2605     }
2606
2607     my $good_records = $e->json_query($query) or return $e->die_event;
2608
2609     my @keep;
2610     for my $d (@$desc) {
2611         if ( grep { $d->record == $_->{id} } @$good_records ) {
2612             push @keep, $d;
2613         }
2614     }
2615
2616     $desc = \@keep;
2617
2618     return { metarecord => $mrec, descriptors => $desc };
2619 }
2620
2621
2622 __PACKAGE__->register_method(
2623     method   => 'fetch_age_protect',
2624     api_name => 'open-ils.search.copy.age_protect.retrieve.all',
2625 );
2626
2627 sub fetch_age_protect {
2628     return new_editor()->retrieve_all_config_rule_age_hold_protect();
2629 }
2630
2631
2632 __PACKAGE__->register_method(
2633     method   => 'copies_by_cn_label',
2634     api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label',
2635 );
2636
2637 __PACKAGE__->register_method(
2638     method   => 'copies_by_cn_label',
2639     api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label.staff',
2640 );
2641
2642 sub copies_by_cn_label {
2643     my( $self, $conn, $record, $cn_parts, $circ_lib ) = @_;
2644     my $e = new_editor();
2645     my $cnp_id = $cn_parts->[0] eq '' ? -1 : $e->search_asset_call_number_prefix({label => $cn_parts->[0]}, {idlist=>1})->[0];
2646     my $cns_id = $cn_parts->[2] eq '' ? -1 : $e->search_asset_call_number_suffix({label => $cn_parts->[2]}, {idlist=>1})->[0];
2647     my $cns = $e->search_asset_call_number({record => $record, prefix => $cnp_id, label => $cn_parts->[1], suffix => $cns_id, deleted => 'f'}, {idlist=>1});
2648     return [] unless @$cns;
2649
2650     # show all non-deleted copies in the staff client ...
2651     if ($self->api_name =~ /staff$/o) {
2652         return $e->search_asset_copy({call_number => $cns, circ_lib => $circ_lib, deleted => 'f'}, {idlist=>1});
2653     }
2654
2655     # ... otherwise, grab the copies ...
2656     my $copies = $e->search_asset_copy(
2657         [ {call_number => $cns, circ_lib => $circ_lib, deleted => 'f', opac_visible => 't'},
2658           {flesh => 1, flesh_fields => { acp => [ qw/location status/] } }
2659         ]
2660     );
2661
2662     # ... and test for location and status visibility
2663     return [ map { ($U->is_true($_->location->opac_visible) && $U->is_true($_->status->opac_visible)) ? ($_->id) : () } @$copies ];
2664 }
2665
2666
2667 1;
2668