Open-ILS/src/perlmods/OpenILS/Application/Search/Biblio.pm

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