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 $cstore = OpenSRF::AppSession->connect('open-ils.cstore');
 541
 542         my $ou = $cstore->request(
 543                 'open-ils.cstore.direct.actor.org_unit.search',
 544                 { parent_ou => undef }
 545         )->gather(1);
 546
 547         my $result = { service => 'native-evergreen-catalog', records => [] };
 548         my $searchhash = { limit => $$args{limit}, offset => $$args{offset}, org_unit => $ou->id };
 549
 550         $$searchhash{searches}{title} = $$args{search}{title};
 551         $$searchhash{searches}{author} = $$args{search}{author};
 552         $$searchhash{searches}{subject} = $$args{search}{subject};
 553         $$searchhash{searches}{keyword} = $$args{search}{keyword};
 554         $$searchhash{searches}{keyword} .= ' '.$$args{search}{tcn};
 555         $$searchhash{searches}{keyword} .= ' '.$$args{search}{isbn};
 556         $$searchhash{searches}{keyword} .= ' '.$$args{search}{publisher};
 557         $$searchhash{searches}{keyword} .= ' '.$$args{search}{pubdate};
 558         $$searchhash{searches}{keyword} .= ' '.$$args{search}{item_type};
 559
 560         my $list = $self->the_quest_for_knowledge( $client, $searchhash );
 561
 562         if ($list->{count} > 0) {
 563                 $result->{count} = $list->{count};
 564
 565                 my $records = $cstore->request(
 566                         'open-ils.cstore.direct.biblio.record_entry.search.atomic',
 567                         { id => [ map { ( $_->[0] ) } @{$list->{ids}} ] }
 568                 )->gather(1);
 569
 570                 for my $rec ( @$records ) {
 571
 572                         my $u = OpenILS::Utils::ModsParser->new();
 573                         $u->start_mods_batch( $rec->marc );
 574                         my $mods = $u->finish_mods_batch();
 575
 576                         push @{ $result->{records} }, { mvr => $mods, marcxml => $rec->marc };
 577
 578                 }
 579
 580         }
 581
 582         return $result;
 583 }
 584
 585 # ----------------------------------------------------------------------------
 586 # These are the main OPAC search methods
 587 # ----------------------------------------------------------------------------
 588
 589 __PACKAGE__->register_method(
 590         method          => 'the_quest_for_knowledge',
 591         api_name                => 'open-ils.search.biblio.multiclass',
 592         signature       => q/
 593                 Performs a multi class bilbli or metabib search
 594                 @param searchhash A search object layed out like so:
 595                         searches : { "$class" : "$value", ...}
 596                         org_unit : The org id to focus the search at
 597                         depth           : The org depth
 598                         limit           : The search limit
 599                         offset  : The search offset
 600                         format  : The MARC format
 601                         sort            : What field to sort the results on [ author | title | pubdate ]
 602                         sort_dir        : What direction do we sort? [ asc | desc ]
 603                 @return An object of the form
 604                         { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }
 605         /
 606 );
 607
 608 __PACKAGE__->register_method(
 609         method          => 'the_quest_for_knowledge',
 610         api_name                => 'open-ils.search.biblio.multiclass.staff',
 611         signature       => q/@see open-ils.search.biblio.multiclass/);
 612 __PACKAGE__->register_method(
 613         method          => 'the_quest_for_knowledge',
 614         api_name                => 'open-ils.search.metabib.multiclass',
 615         signature       => q/@see open-ils.search.biblio.multiclass/);
 616 __PACKAGE__->register_method(
 617         method          => 'the_quest_for_knowledge',
 618         api_name                => 'open-ils.search.metabib.multiclass.staff',
 619         signature       => q/@see open-ils.search.biblio.multiclass/);
 620
 621 sub the_quest_for_knowledge {
 622         my( $self, $conn, $searchhash, $docache ) = @_;
 623
 624         return { count => 0 } unless $searchhash and
 625                 ref $searchhash->{searches} eq 'HASH';
 626
 627         my $method = 'open-ils.storage.biblio.multiclass.search_fts';
 628         my $ismeta = 0;
 629         my @recs;
 630
 631         if($self->api_name =~ /metabib/) {
 632                 $ismeta = 1;
 633                 $method =~ s/biblio/metabib/o;
 634         }
 635
 636
 637         my $offset      = $searchhash->{offset} || 0;
 638         my $limit       = $searchhash->{limit} || 10;
 639         my $end         = $offset + $limit - 1;
 640
 641         # do some simple sanity checking
 642         if(!$searchhash->{searches} or
 643                 ( !grep { /^(?:title|author|subject|series|keyword)/ } keys %{$searchhash->{searches}} ) ) {
 644                 return { count => 0 };
 645         }
 646
 647
 648         my $maxlimit = 5000;
 649         $searchhash->{offset}   = 0;
 650         $searchhash->{limit}            = $maxlimit;
 651
 652         return { count => 0 } if $offset > $maxlimit;
 653
 654         my @search;
 655         push( @search, ($_ => $$searchhash{$_})) for (sort keys %$searchhash);
 656         my $s = OpenSRF::Utils::JSON->perl2JSON(\@search);
 657         my $ckey = $pfx . md5_hex($method . $s);
 658
 659         $logger->info("bib search for: $s");
 660
 661         $searchhash->{limit} -= $offset;
 662
 663
 664     my $trim = 0;
 665         my $result = ($docache) ? search_cache($ckey, $offset, $limit) : undef;
 666
 667         if(!$result) {
 668
 669                 $method .= ".staff" if($self->api_name =~ /staff/);
 670                 $method .= ".atomic";
 671
 672                 for (keys %$searchhash) {
 673                         delete $$searchhash{$_}
 674                                 unless defined $$searchhash{$_};
 675                 }
 676
 677                 $result = $U->storagereq( $method, %$searchhash );
 678         $trim = 1;
 679
 680         } else {
 681                 $docache = 0;
 682         }
 683
 684         return {count => 0} unless ($result && $$result[0]);
 685
 686         @recs = @$result;
 687
 688         my $count = ($ismeta) ? $result->[0]->[3] : $result->[0]->[2];
 689
 690         if($docache) {
 691                 # If we didn't get this data from the cache, put it into the cache
 692                 # then return the correct offset of records
 693                 $logger->debug("putting search cache $ckey\n");
 694                 put_cache($ckey, $count, \@recs);
 695         }
 696
 697     if($trim) {
 698         # if we have the full set of data, trim out
 699         # the requested chunk based on limit and offset
 700         my @t;
 701         for ($offset..$end) {
 702             last unless $recs[$_];
 703             push(@t, $recs[$_]);
 704         }
 705         @recs = @t;
 706     }
 707
 708         return { ids => \@recs, count => $count };
 709 }
 710
 711
 712
 713 sub search_cache {
 714
 715         my $key         = shift;
 716         my $offset      = shift;
 717         my $limit       = shift;
 718         my $start       = $offset;
 719         my $end         = $offset + $limit - 1;
 720
 721         $logger->debug("searching cache for $key : $start..$end\n");
 722
 723         return undef unless $cache;
 724         my $data = $cache->get_cache($key);
 725
 726         return undef unless $data;
 727
 728         my $count = $data->[0];
 729         $data = $data->[1];
 730
 731         return undef unless $offset < $count;
 732
 733
 734         my @result;
 735         for( my $i = $offset; $i <= $end; $i++ ) {
 736                 last unless my $d = $$data[$i];
 737                 push( @result, $d );
 738         }
 739
 740         $logger->debug("search_cache found ".scalar(@result)." items for count=$count, start=$start, end=$end");
 741
 742         return \@result;
 743 }
 744
 745
 746 sub put_cache {
 747         my( $key, $count, $data ) = @_;
 748         return undef unless $cache;
 749         $logger->debug("search_cache putting ".
 750                 scalar(@$data)." items at key $key with timeout $cache_timeout");
 751         $cache->put_cache($key, [ $count, $data ], $cache_timeout);
 752 }
 753
 754
 755
 756
 757
 758
 759 __PACKAGE__->register_method(
 760         method  => "biblio_mrid_to_modsbatch_batch",
 761         api_name        => "open-ils.search.biblio.metarecord.mods_slim.batch.retrieve");
 762
 763 sub biblio_mrid_to_modsbatch_batch {
 764         my( $self, $client, $mrids) = @_;
 765         warn "Performing mrid_to_modsbatch_batch...";
 766         my @mods;
 767         my $method = $self->method_lookup("open-ils.search.biblio.metarecord.mods_slim.retrieve");
 768         for my $id (@$mrids) {
 769                 next unless defined $id;
 770                 my ($m) = $method->run($id);
 771                 push @mods, $m;
 772         }
 773         return \@mods;
 774 }
 775
 776
 777 __PACKAGE__->register_method(
 778         method  => "biblio_mrid_to_modsbatch",
 779         api_name        => "open-ils.search.biblio.metarecord.mods_slim.retrieve",
 780         notes           => <<"  NOTES");
 781         Returns the mvr associated with a given metarecod. If none exists,
 782         it is created.
 783         NOTES
 784
 785 __PACKAGE__->register_method(
 786         method  => "biblio_mrid_to_modsbatch",
 787         api_name        => "open-ils.search.biblio.metarecord.mods_slim.retrieve.staff",
 788         notes           => <<"  NOTES");
 789         Returns the mvr associated with a given metarecod. If none exists,
 790         it is created.
 791         NOTES
 792
 793 sub biblio_mrid_to_modsbatch {
 794         my( $self, $client, $mrid, $args) = @_;
 795
 796         warn "Grabbing mvr for $mrid\n";
 797
 798         my ($mr, $evt) = _grab_metarecord($mrid);
 799         return $evt unless $mr;
 800
 801         my $mvr = $self->biblio_mrid_check_mvr($client, $mr);
 802         $mvr = $self->biblio_mrid_make_modsbatch( $client, $mr ) unless $mvr;
 803
 804         return $mvr unless ref($args);
 805
 806         # Here we find the lead record appropriate for the given filters
 807         # and use that for the title and author of the metarecord
 808         my $format      = $$args{format};
 809         my $org         = $$args{org};
 810         my $depth       = $$args{depth};
 811
 812         return $mvr unless $format or $org or $depth;
 813
 814         my $method = "open-ils.storage.ordered.metabib.metarecord.records";
 815         $method = "$method.staff" if $self->api_name =~ /staff/o;
 816
 817         my $rec = $U->storagereq($method, $format, $org, $depth, 1);
 818
 819         if( my $mods = $U->record_to_mvr($rec) ) {
 820
 821                 $mvr->title($mods->title);
 822                 $mvr->title($mods->author);
 823                 $logger->debug("mods_slim updating title and ".
 824                         "author in mvr with ".$mods->title." : ".$mods->author);
 825         }
 826
 827         return $mvr;
 828 }
 829
 830 # converts a metarecord to an mvr
 831 sub _mr_to_mvr {
 832         my $mr = shift;
 833         my $perl = OpenSRF::Utils::JSON->JSON2perl($mr->mods());
 834         return Fieldmapper::metabib::virtual_record->new($perl);
 835 }
 836
 837 # checks to see if a metarecord has mods, if so returns true;
 838
 839 __PACKAGE__->register_method(
 840         method  => "biblio_mrid_check_mvr",
 841         api_name        => "open-ils.search.biblio.metarecord.mods_slim.check",
 842         notes           => <<"  NOTES");
 843         Takes a metarecord ID or a metarecord object and returns true
 844         if the metarecord already has an mvr associated with it.
 845         NOTES
 846
 847 sub biblio_mrid_check_mvr {
 848         my( $self, $client, $mrid ) = @_;
 849         my $mr;
 850
 851         my $evt;
 852         if(ref($mrid)) { $mr = $mrid; }
 853         else { ($mr, $evt) = _grab_metarecord($mrid); }
 854         return $evt if $evt;
 855
 856         warn "Checking mvr for mr " . $mr->id . "\n";
 857
 858         return _mr_to_mvr($mr) if $mr->mods();
 859         return undef;
 860 }
 861
 862 sub _grab_metarecord {
 863         my $mrid = shift;
 864         #my $e = OpenILS::Utils::Editor->new;
 865         my $e = new_editor();
 866         my $mr = $e->retrieve_metabib_metarecord($mrid) or return ( undef, $e->event );
 867         return ($mr);
 868 }
 869
 870
 871 __PACKAGE__->register_method(
 872         method  => "biblio_mrid_make_modsbatch",
 873         api_name        => "open-ils.search.biblio.metarecord.mods_slim.create",
 874         notes           => <<"  NOTES");
 875         Takes either a metarecord ID or a metarecord object.
 876         Forces the creations of an mvr for the given metarecord.
 877         The created mvr is returned.
 878         NOTES
 879
 880 sub biblio_mrid_make_modsbatch {
 881         my( $self, $client, $mrid ) = @_;
 882
 883         #my $e = OpenILS::Utils::Editor->new;
 884         my $e = new_editor();
 885
 886         my $mr;
 887         if( ref($mrid) ) {
 888                 $mr = $mrid;
 889                 $mrid = $mr->id;
 890         } else {
 891                 $mr = $e->retrieve_metabib_metarecord($mrid)
 892                         or return $e->event;
 893         }
 894
 895         my $masterid = $mr->master_record;
 896         $logger->info("creating new mods batch for metarecord=$mrid, master record=$masterid");
 897
 898         my $ids = $U->storagereq(
 899                 'open-ils.storage.ordered.metabib.metarecord.records.staff.atomic', $mrid);
 900         return undef unless @$ids;
 901
 902         my $master = $e->retrieve_biblio_record_entry($masterid)
 903                 or return $e->event;
 904
 905         # start the mods batch
 906         my $u = OpenILS::Utils::ModsParser->new();
 907         $u->start_mods_batch( $master->marc );
 908
 909         # grab all of the sub-records and shove them into the batch
 910         my @ids = grep { $_ ne $masterid } @$ids;
 911         #my $subrecs = (@ids) ? $e->batch_retrieve_biblio_record_entry(\@ids) : [];
 912
 913         my $subrecs = [];
 914         if(@$ids) {
 915                 for my $i (@$ids) {
 916                         my $r = $e->retrieve_biblio_record_entry($i);
 917                         push( @$subrecs, $r ) if $r;
 918                 }
 919         }
 920
 921         for(@$subrecs) {
 922                 $logger->debug("adding record ".$_->id." to mods batch for metarecord=$mrid");
 923                 $u->push_mods_batch( $_->marc ) if $_->marc;
 924         }
 925
 926
 927         # finish up and send to the client
 928         my $mods = $u->finish_mods_batch();
 929         $mods->doc_id($mrid);
 930         $client->respond_complete($mods);
 931
 932
 933         # now update the mods string in the db
 934         my $string = OpenSRF::Utils::JSON->perl2JSON($mods->decast);
 935         $mr->mods($string);
 936
 937         #$e = OpenILS::Utils::Editor->new(xact => 1);
 938         $e = new_editor(xact => 1);
 939         $e->update_metabib_metarecord($mr)
 940                 or $logger->error("Error setting mods text on metarecord $mrid : " . Dumper($e->event));
 941         $e->finish;
 942
 943         return undef;
 944 }
 945
 946
 947
 948
 949 # converts a mr id into a list of record ids
 950
 951 __PACKAGE__->register_method(
 952         method  => "biblio_mrid_to_record_ids",
 953         api_name        => "open-ils.search.biblio.metarecord_to_records",
 954 );
 955
 956 __PACKAGE__->register_method(
 957         method  => "biblio_mrid_to_record_ids",
 958         api_name        => "open-ils.search.biblio.metarecord_to_records.staff",
 959 );
 960
 961 sub biblio_mrid_to_record_ids {
 962         my( $self, $client, $mrid, $args ) = @_;
 963
 964         my $format      = $$args{format};
 965         my $org         = $$args{org};
 966         my $depth       = $$args{depth};
 967
 968         my $method = "open-ils.storage.ordered.metabib.metarecord.records.atomic";
 969         $method =~ s/atomic/staff\.atomic/o if $self->api_name =~ /staff/o;
 970         my $recs = $U->storagereq($method, $mrid, $format, $org, $depth);
 971
 972         return { count => scalar(@$recs), ids => $recs };
 973 }
 974
 975
 976 __PACKAGE__->register_method(
 977         method  => "biblio_record_to_marc_html",
 978         api_name        => "open-ils.search.biblio.record.html" );
 979
 980 my $parser              = XML::LibXML->new();
 981 my $xslt                        = XML::LibXSLT->new();
 982 my $marc_sheet;
 983
 984 my $settings_client = OpenSRF::Utils::SettingsClient->new();
 985 sub biblio_record_to_marc_html {
 986         my( $self, $client, $recordid ) = @_;
 987
 988         if( !$marc_sheet ) {
 989                 my $dir = $settings_client->config_value( "dirs", "xsl" );
 990                 my $xsl = $settings_client->config_value(
 991                         "apps", "open-ils.search", "app_settings", "marc_html_xsl" );
 992
 993                 $xsl = $parser->parse_file("$dir/$xsl");
 994                 $marc_sheet = $xslt->parse_stylesheet( $xsl );
 995         }
 996
 997
 998         my $record = $apputils->simple_scalar_request(
 999                 "open-ils.cstore",
1000                 "open-ils.cstore.direct.biblio.record_entry.retrieve",
1001                 $recordid );
1002
1003         my $xmldoc = $parser->parse_string($record->marc);
1004         my $html = $marc_sheet->transform($xmldoc);
1005         $html = $html->toString();
1006         return $html;
1007
1008 }
1009
1010
1011 =head duplicate
1012 __PACKAGE__->register_method(
1013         method  => "retrieve_all_copy_locations",
1014         api_name        => "open-ils.search.config.copy_location.retrieve.all" );
1015
1016 my $shelving_locations;
1017 sub retrieve_all_copy_locations {
1018         my( $self, $client ) = @_;
1019         if(!$shelving_locations) {
1020                 $shelving_locations = $apputils->simple_scalar_request(
1021                         "open-ils.cstore",
1022                         "open-ils.cstore.direct.asset.copy_location.search.atomic",
1023                         { id => { "!=" => undef } }
1024                 );
1025         }
1026         return $shelving_locations;
1027 }
1028 =cut
1029
1030
1031
1032 __PACKAGE__->register_method(
1033         method  => "retrieve_all_copy_statuses",
1034         api_name        => "open-ils.search.config.copy_status.retrieve.all" );
1035
1036 my $copy_statuses;
1037 sub retrieve_all_copy_statuses {
1038         my( $self, $client ) = @_;
1039         return $copy_statuses if $copy_statuses;
1040         return $copy_statuses =
1041                 new_editor()->retrieve_all_config_copy_status();
1042 }
1043
1044
1045 __PACKAGE__->register_method(
1046         method  => "copy_counts_per_org",
1047         api_name        => "open-ils.search.biblio.copy_counts.retrieve");
1048
1049 __PACKAGE__->register_method(
1050         method  => "copy_counts_per_org",
1051         api_name        => "open-ils.search.biblio.copy_counts.retrieve.staff");
1052
1053 sub copy_counts_per_org {
1054         my( $self, $client, $record_id ) = @_;
1055
1056         warn "Retreiveing copy copy counts for record $record_id and method " . $self->api_name . "\n";
1057
1058         my $method = "open-ils.storage.biblio.record_entry.global_copy_count.atomic";
1059         if($self->api_name =~ /staff/) { $method =~ s/atomic/staff\.atomic/; }
1060
1061         my $counts = $apputils->simple_scalar_request(
1062                 "open-ils.storage", $method, $record_id );
1063
1064         $counts = [ sort {$a->[0] <=> $b->[0]} @$counts ];
1065         return $counts;
1066 }
1067
1068
1069 __PACKAGE__->register_method(
1070         method          => "copy_count_summary",
1071         api_name        => "open-ils.search.biblio.copy_counts.summary.retrieve",
1072         notes           => <<"  NOTES");
1073         returns an array of these:
1074                 [ org_id, callnumber_label, <status1_count>, <status2_cout>,...]
1075                 where statusx is a copy status name.  the statuses are sorted
1076                 by id.
1077         NOTES
1078
1079 sub copy_count_summary {
1080         my( $self, $client, $rid, $org, $depth ) = @_;
1081         $org ||= 1;
1082         $depth ||= 0;
1083     my $data = $U->storagereq(
1084                 'open-ils.storage.biblio.record_entry.status_copy_count.atomic', $rid, $org, $depth );
1085
1086     return [ sort { $a->[1] cmp $b->[1] } @$data ];
1087 }
1088
1089
1090
1091 =head
1092 __PACKAGE__->register_method(
1093         method          => "multiclass_search",
1094         api_name        => "open-ils.search.biblio.multiclass",
1095         notes           => <<"  NOTES");
1096                 Performs a multiclass search
1097                 PARAMS( searchBlob, org_unit, format, limit )
1098                 where searchBlob is defined like this:
1099                         {
1100                                 "title" : { "term" : "water" },
1101                                 "author" : { "term" : "smith" },
1102                                 ...
1103                         }
1104         NOTES
1105
1106 __PACKAGE__->register_method(
1107         method          => "multiclass_search",
1108         api_name        => "open-ils.search.biblio.multiclass.staff",
1109         notes           => "see open-ils.search.biblio.multiclass" );
1110
1111 sub multiclass_search {
1112         my( $self, $client, $searchBlob, $orgid, $format, $limit ) = @_;
1113
1114         $logger->debug("Performing multiclass search with org => $orgid, " .
1115                 "format => $format, limit => $limit, and search blob " . Dumper($searchBlob));
1116
1117         my $meth = 'open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.atomic';
1118         if($self->api_name =~ /staff/) { $meth =~ s/metarecord\.atomic/metarecord.staff.atomic/; }
1119
1120
1121         my $records = $apputils->simplereq(
1122                 'open-ils.storage', $meth,
1123                  org_unit => $orgid, searches => $searchBlob, format => $format, limit => $limit );
1124
1125         my $count = 0;
1126         my $recs = [];
1127
1128         if( ref($records) and $records->[0] and
1129                 defined($records->[0]->[3])) { $count = $records->[0]->[3];}
1130
1131         for my $r (@$records) { push( @$recs, $r ) if ($r and $r->[0]); }
1132
1133         # records has the form: [ mrid, rank, singleRecord / 0, hitCount ];
1134         return { ids => $recs, count => $count };
1135 }
1136 =cut
1137
1138
1139 =head comment-1
1140 __PACKAGE__->register_method(
1141         method          => "multiclass_search",
1142         api_name                => "open-ils.search.biblio.multiclass",
1143         signature       => q/
1144                 Performs a multiclass search
1145                 @param args A names hash of arguments:
1146                         org_unit : The org to focus the search on
1147                         depth           : The search depth
1148                         format  : Item format
1149                         limit           : Return limit
1150                         offset  : Search offset
1151                         searches : A named hash of searches which has the following format:
1152                                 {
1153                                         "title" : { "term" : "water" },
1154                                         "author" : { "term" : "smith" },
1155                                         ...
1156                                 }
1157                 @return { ids : <array of ids>, count : hitcount }
1158         /
1159 );
1160
1161 __PACKAGE__->register_method(
1162         method          => "multiclass_search",
1163         api_name                => "open-ils.search.biblio.multiclass.staff",
1164         notes           => q/@see open-ils.search.biblio.multiclass/ );
1165
1166 sub multiclass_search {
1167         my( $self, $client, $args ) = @_;
1168
1169         $logger->debug("Performing multiclass search with args:\n" . Dumper($args));
1170         my $meth = 'open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.atomic';
1171         if($self->api_name =~ /staff/) { $meth =~ s/metarecord\.atomic/metarecord.staff.atomic/; }
1172
1173         my $records = $apputils->simplereq( 'open-ils.storage', $meth, %$args );
1174
1175         my $count = 0;
1176         my $recs = [];
1177
1178         if( ref($records) and $records->[0] and
1179                 defined($records->[0]->[3])) { $count = $records->[0]->[3];}
1180
1181         for my $r (@$records) { push( @$recs, $r ) if ($r and $r->[0]); }
1182
1183         return { ids => $recs, count => $count };
1184 }
1185
1186 =cut
1187
1188
1189
1190 __PACKAGE__->register_method(
1191         method          => "marc_search",
1192         api_name        => "open-ils.search.biblio.marc.staff");
1193
1194 __PACKAGE__->register_method(
1195         method          => "marc_search",
1196         api_name        => "open-ils.search.biblio.marc",
1197         notes           => <<"  NOTES");
1198                 Example:
1199                 open-ils.storage.biblio.full_rec.multi_search.atomic
1200                 { "searches": [{"term":"harry","restrict": [{"tag":245,"subfield":"a"}]}], "org_unit": 1,
1201         "limit":5,"sort":"author","item_type":"g"}
1202         NOTES
1203
1204 sub marc_search {
1205         my( $self, $conn, $args, $limit, $offset ) = @_;
1206
1207         my $method = 'open-ils.storage.biblio.full_rec.multi_search';
1208         $method .= ".staff" if $self->api_name =~ /staff/;
1209         $method .= ".atomic";
1210
1211         $limit ||= 10;
1212         $offset ||= 0;
1213
1214         my @search;
1215         push( @search, ($_ => $$args{$_}) ) for (sort keys %$args);
1216         my $ckey = $pfx . md5_hex($method . OpenSRF::Utils::JSON->perl2JSON(\@search));
1217
1218         my $recs = search_cache($ckey, $offset, $limit);
1219
1220         if(!$recs) {
1221                 $recs = $U->storagereq($method, %$args) || [];
1222                 if( $recs ) {
1223                         put_cache($ckey, scalar(@$recs), $recs);
1224                         $recs = [ @$recs[$offset..($offset + ($limit - 1))] ];
1225                 } else {
1226                         $recs = [];
1227                 }
1228         }
1229
1230         my $count = 0;
1231         $count = $recs->[0]->[2] if $recs->[0] and $recs->[0]->[2];
1232         my @recs = map { $_->[0] } @$recs;
1233
1234         return { ids => \@recs, count => $count };
1235 }
1236
1237
1238 __PACKAGE__->register_method(
1239         method  => "biblio_search_isbn",
1240         api_name        => "open-ils.search.biblio.isbn",
1241 );
1242
1243 sub biblio_search_isbn {
1244         my( $self, $client, $isbn ) = @_;
1245         $logger->debug("Searching ISBN $isbn");
1246         my $e = new_editor();
1247         my $recs = $U->storagereq(
1248                 'open-ils.storage.id_list.biblio.record_entry.search.isbn.atomic', $isbn );
1249         return { ids => $recs, count => scalar(@$recs) };
1250 }
1251
1252
1253 __PACKAGE__->register_method(
1254         method  => "biblio_search_issn",
1255         api_name        => "open-ils.search.biblio.issn",
1256 );
1257
1258 sub biblio_search_issn {
1259         my( $self, $client, $issn ) = @_;
1260         $logger->debug("Searching ISSN $issn");
1261         my $e = new_editor();
1262         my $recs = $U->storagereq(
1263                 'open-ils.storage.id_list.biblio.record_entry.search.issn.atomic', $issn );
1264         return { ids => $recs, count => scalar(@$recs) };
1265 }
1266
1267
1268
1269
1270 __PACKAGE__->register_method(
1271         method  => "fetch_mods_by_copy",
1272         api_name        => "open-ils.search.biblio.mods_from_copy",
1273 );
1274
1275 sub fetch_mods_by_copy {
1276         my( $self, $client, $copyid ) = @_;
1277         my ($record, $evt) = $apputils->fetch_record_by_copy( $copyid );
1278         return $evt if $evt;
1279         return OpenILS::Event->new('ITEM_NOT_CATALOGED') unless $record->marc;
1280         return $apputils->record_to_mvr($record);
1281 }
1282
1283
1284
1285 # -------------------------------------------------------------------------------------
1286
1287 __PACKAGE__->register_method(
1288         method  => "cn_browse",
1289         api_name        => "open-ils.search.callnumber.browse.target",
1290         notes           => "Starts a callnumber browse"
1291         );
1292
1293 __PACKAGE__->register_method(
1294         method  => "cn_browse",
1295         api_name        => "open-ils.search.callnumber.browse.page_up",
1296         notes           => "Returns the previous page of callnumbers",
1297         );
1298
1299 __PACKAGE__->register_method(
1300         method  => "cn_browse",
1301         api_name        => "open-ils.search.callnumber.browse.page_down",
1302         notes           => "Returns the next page of callnumbers",
1303         );
1304
1305
1306 # RETURNS array of arrays like so: label, owning_lib, record, id
1307 sub cn_browse {
1308         my( $self, $client, @params ) = @_;
1309         my $method;
1310
1311         $method = 'open-ils.storage.asset.call_number.browse.target.atomic'
1312                 if( $self->api_name =~ /target/ );
1313         $method = 'open-ils.storage.asset.call_number.browse.page_up.atomic'
1314                 if( $self->api_name =~ /page_up/ );
1315         $method = 'open-ils.storage.asset.call_number.browse.page_down.atomic'
1316                 if( $self->api_name =~ /page_down/ );
1317
1318         return $apputils->simplereq( 'open-ils.storage', $method, @params );
1319 }
1320 # -------------------------------------------------------------------------------------
1321
1322 __PACKAGE__->register_method(
1323         method => "fetch_cn",
1324         api_name => "open-ils.search.callnumber.retrieve",
1325         notes           => "retrieves a callnumber based on ID",
1326         );
1327
1328 sub fetch_cn {
1329         my( $self, $client, $id ) = @_;
1330         my( $cn, $evt ) = $apputils->fetch_callnumber( $id );
1331         return $evt if $evt;
1332         return $cn;
1333 }
1334
1335 __PACKAGE__->register_method (
1336         method          => "fetch_copy_by_cn",
1337         api_name                => 'open-ils.search.copies_by_call_number.retrieve',
1338         signature       => q/
1339                 Returns an array of copy id's by callnumber id
1340                 @param cnid The callnumber id
1341                 @return An array of copy ids
1342         /
1343 );
1344
1345 sub fetch_copy_by_cn {
1346         my( $self, $conn, $cnid ) = @_;
1347         return $U->cstorereq(
1348                 'open-ils.cstore.direct.asset.copy.id_list.atomic',
1349                 { call_number => $cnid, deleted => 'f' } );
1350 }
1351
1352 __PACKAGE__->register_method (
1353         method          => 'fetch_cn_by_info',
1354         api_name                => 'open-ils.search.call_number.retrieve_by_info',
1355         signature       => q/
1356                 @param label The callnumber label
1357                 @param record The record the cn is attached to
1358                 @param org The owning library of the cn
1359                 @return The callnumber object
1360         /
1361 );
1362
1363
1364 sub fetch_cn_by_info {
1365         my( $self, $conn, $label, $record, $org ) = @_;
1366         return $U->cstorereq(
1367                 'open-ils.cstore.direct.asset.call_number.search',
1368                 { label => $label, record => $record, owning_lib => $org, deleted => 'f' });
1369 }
1370
1371
1372
1373
1374
1375 __PACKAGE__->register_method (
1376         method => 'bib_extras',
1377         api_name => 'open-ils.search.biblio.lit_form_map.retrieve.all');
1378 __PACKAGE__->register_method (
1379         method => 'bib_extras',
1380         api_name => 'open-ils.search.biblio.item_form_map.retrieve.all');
1381 __PACKAGE__->register_method (
1382         method => 'bib_extras',
1383         api_name => 'open-ils.search.biblio.item_type_map.retrieve.all');
1384 __PACKAGE__->register_method (
1385         method => 'bib_extras',
1386         api_name => 'open-ils.search.biblio.audience_map.retrieve.all');
1387
1388 sub bib_extras {
1389         my $self = shift;
1390
1391         my $e = new_editor();
1392
1393         return $e->retrieve_all_config_lit_form_map()
1394                 if( $self->api_name =~ /lit_form/ );
1395
1396         return $e->retrieve_all_config_item_form_map()
1397                 if( $self->api_name =~ /item_form_map/ );
1398
1399         return $e->retrieve_all_config_item_type_map()
1400                 if( $self->api_name =~ /item_type_map/ );
1401
1402         return $e->retrieve_all_config_audience_map()
1403                 if( $self->api_name =~ /audience_map/ );
1404
1405         return [];
1406 }
1407
1408
1409
1410 __PACKAGE__->register_method(
1411         method  => 'fetch_slim_record',
1412         api_name        => 'open-ils.search.biblio.record_entry.slim.retrieve',
1413         signature=> q/
1414                 Returns a biblio.record_entry without the attached marcxml
1415         /
1416 );
1417
1418 sub fetch_slim_record {
1419         my( $self, $conn, $ids ) = @_;
1420
1421         #my $editor = OpenILS::Utils::Editor->new;
1422         my $editor = new_editor();
1423         my @res;
1424         for( @$ids ) {
1425                 return $editor->event unless
1426                         my $r = $editor->retrieve_biblio_record_entry($_);
1427                 $r->clear_marc;
1428                 push(@res, $r);
1429         }
1430         return \@res;
1431 }
1432
1433
1434
1435 __PACKAGE__->register_method(
1436         method => 'rec_to_mr_rec_descriptors',
1437         api_name        => 'open-ils.search.metabib.record_to_descriptors',
1438         signature       => q/
1439                 specialized method...
1440                 Given a biblio record id or a metarecord id,
1441                 this returns a list of metabib.record_descriptor
1442                 objects that live within the same metarecord
1443                 @param args Object of args including:
1444         /
1445 );
1446
1447 sub rec_to_mr_rec_descriptors {
1448         my( $self, $conn, $args ) = @_;
1449
1450         my $rec = $$args{record};
1451         my $mrec        = $$args{metarecord};
1452         my $item_forms = $$args{item_forms};
1453         my $item_types  = $$args{item_types};
1454         my $item_lang   = $$args{item_lang};
1455
1456         my $e = new_editor();
1457         my $recs;
1458
1459         if( !$mrec ) {
1460                 my $map = $e->search_metabib_metarecord_source_map({source => $rec});
1461                 return $e->event unless @$map;
1462                 $mrec = $$map[0]->metarecord;
1463         }
1464
1465         $recs = $e->search_metabib_metarecord_source_map({metarecord => $mrec});
1466         return $e->event unless @$recs;
1467
1468         my @recs = map { $_->source } @$recs;
1469         my $search = { record => \@recs };
1470         $search->{item_form} = $item_forms if $item_forms and @$item_forms;
1471         $search->{item_type} = $item_types if $item_types and @$item_types;
1472         $search->{item_lang} = $item_lang if $item_lang;
1473
1474         my $desc = $e->search_metabib_record_descriptor($search);
1475
1476         return { metarecord => $mrec, descriptors => $desc };
1477 }
1478
1479
1480
1481
1482 __PACKAGE__->register_method(
1483         method => 'copies_created_on',
1484 );
1485
1486
1487 sub copies_created_on {
1488         my( $self, $conn, $auth, $org, $date ) = @_;
1489         my $e = new_editor(authtoken=>$auth);
1490         return $e->event unless $e->checkauth;
1491 }
1492
1493
1494 __PACKAGE__->register_method(
1495         method => 'fetch_age_protect',
1496         api_name => 'open-ils.search.copy.age_protect.retrieve.all',
1497 );
1498
1499 sub fetch_age_protect {
1500         return new_editor()->retrieve_all_config_rule_age_hold_protect();
1501 }
1502
1503
1504 __PACKAGE__->register_method(
1505         method => 'copies_by_cn_label',
1506         api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label',
1507 );
1508
1509 __PACKAGE__->register_method(
1510         method => 'copies_by_cn_label',
1511         api_name => 'open-ils.search.asset.copy.retrieve_by_cn_label.staff',
1512 );
1513
1514 sub copies_by_cn_label {
1515         my( $self, $conn, $record, $label, $circ_lib ) = @_;
1516         my $e = new_editor();
1517         my $cns = $e->search_asset_call_number({record => $record, label => $label, deleted => 'f'}, {idlist=>1});
1518         return [] unless @$cns;
1519
1520         # show all non-deleted copies in the staff client ...
1521         if ($self->api_name =~ /staff$/o) {
1522                 return $e->search_asset_copy({call_number => $cns, circ_lib => $circ_lib, deleted => 'f'}, {idlist=>1});
1523         }
1524
1525         # ... otherwise, grab the copies ...
1526         my $copies = $e->search_asset_copy(
1527                 [ {call_number => $cns, circ_lib => $circ_lib, deleted => 'f', opac_visible => 't'},
1528                   {flesh => 1, flesh_fields => { acp => [ qw/location status/] } }
1529                 ]
1530         );
1531
1532         # ... and test for location and status visibility
1533         return [ map { ($U->is_true($_->location->opac_visible) && $U->is_true($_->status->holdable)) ? ($_->id) : () } @$copies ];
1534 }
1535
1536
1537
1538 1;
1539
1540