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 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
  13 use OpenSRF::Utils::Logger qw/:logger/;
  14
  15
  16 use JSON;
  17
  18 use Time::HiRes qw(time);
  19 use OpenSRF::EX qw(:try);
  20 use Digest::MD5 qw(md5_hex);
  21
  22 use XML::LibXML;
  23 use XML::LibXSLT;
  24
  25 use Data::Dumper;
  26 $Data::Dumper::Indent = 0;
  27
  28 use OpenILS::Application::AppUtils;
  29 my $apputils = "OpenILS::Application::AppUtils";
  30 my $U = $apputils;
  31
  32 my $pfx = "open-ils.search_";
  33
  34 my $cache;
  35 my $cache_timeout;
  36
  37 sub initialize {
  38         $cache = OpenSRF::Utils::Cache->new('global');
  39         my $sclient = OpenSRF::Utils::SettingsClient->new();
  40         $cache_timeout = $sclient->config_value(
  41                         "apps", "open-ils.search", "app_settings", "cache_timeout" ) || 300;
  42         $logger->info("Search cache timeout is $cache_timeout");
  43 }
  44
  45
  46
  47 # ---------------------------------------------------------------------------
  48 # takes a list of record id's and turns the docs into friendly
  49 # mods structures. Creates one MODS structure for each doc id.
  50 # ---------------------------------------------------------------------------
  51 sub _records_to_mods {
  52         my @ids = @_;
  53
  54         my @results;
  55         my @marcxml_objs;
  56
  57         my $session = OpenSRF::AppSession->create("open-ils.storage");
  58         my $request = $session->request(
  59                         "open-ils.storage.direct.biblio.record_entry.batch.retrieve",  @ids );
  60
  61         while( my $resp = $request->recv ) {
  62                 my $content = $resp->content;
  63                 my $u = OpenILS::Utils::ModsParser->new();
  64                 $u->start_mods_batch( $content->marc );
  65                 my $mods = $u->finish_mods_batch();
  66                 $mods->doc_id($content->id());
  67                 $mods->tcn($content->tcn_value);
  68                 push @results, $mods;
  69         }
  70
  71         $session->disconnect();
  72         return \@results;
  73 }
  74
  75 __PACKAGE__->register_method(
  76         method  => "record_id_to_mods",
  77         api_name        => "open-ils.search.biblio.record.mods.retrieve",
  78         argc            => 1,
  79         note            => "Provide ID, we provide the mods"
  80 );
  81
  82 # converts a record into a mods object with copy counts attached
  83 sub record_id_to_mods {
  84
  85         my( $self, $client, $org_id, $id ) = @_;
  86
  87         my $mods_list = _records_to_mods( $id );
  88         my $mods_obj = $mods_list->[0];
  89         my $cmethod = $self->method_lookup(
  90                         "open-ils.search.biblio.record.copy_count");
  91         my ($count) = $cmethod->run($org_id, $id);
  92         $mods_obj->copy_count($count);
  93
  94         return $mods_obj;
  95 }
  96
  97
  98
  99 __PACKAGE__->register_method(
 100         method  => "record_id_to_mods_slim",
 101         api_name        => "open-ils.search.biblio.record.mods_slim.retrieve",
 102         argc            => 1,
 103         note            => "Provide ID, we provide the mods"
 104 );
 105
 106 # converts a record into a mods object with NO copy counts attached
 107 sub record_id_to_mods_slim {
 108         my( $self, $client, $id ) = @_;
 109         return undef unless defined $id;
 110
 111         if(ref($id) and ref($id) == 'ARRAY') {
 112                 return _records_to_mods( @$id );
 113         }
 114         my $mods_list = _records_to_mods( $id );
 115         my $mods_obj = $mods_list->[0];
 116         return $mods_obj;
 117 }
 118
 119
 120 # Returns the number of copies attached to a record based on org location
 121 __PACKAGE__->register_method(
 122         method  => "record_id_to_copy_count",
 123         api_name        => "open-ils.search.biblio.record.copy_count",
 124 );
 125
 126 __PACKAGE__->register_method(
 127         method  => "record_id_to_copy_count",
 128         api_name        => "open-ils.search.biblio.record.copy_count.staff",
 129 );
 130
 131 __PACKAGE__->register_method(
 132         method  => "record_id_to_copy_count",
 133         api_name        => "open-ils.search.biblio.metarecord.copy_count",
 134 );
 135
 136 __PACKAGE__->register_method(
 137         method  => "record_id_to_copy_count",
 138         api_name        => "open-ils.search.biblio.metarecord.copy_count.staff",
 139 );
 140 sub record_id_to_copy_count {
 141         my( $self, $client, $org_id, $record_id, $format ) = @_;
 142
 143         return [] unless $record_id;
 144         $format = undef if (!$format or $format eq 'all');
 145
 146         my $method = "open-ils.storage.biblio.record_entry.copy_count.atomic";
 147         my $key = "record";
 148
 149         if($self->api_name =~ /metarecord/) {
 150                 $method = "open-ils.storage.metabib.metarecord.copy_count.atomic";
 151                 $key = "metarecord";
 152         }
 153
 154         $method =~ s/atomic/staff\.atomic/og if($self->api_name =~ /staff/ );
 155
 156         my $count = $U->storagereq( $method,
 157                 org_unit => $org_id, $key => $record_id, format => $format );
 158
 159         return [ sort { $a->{depth} <=> $b->{depth} } @$count ];
 160 }
 161
 162
 163
 164
 165 __PACKAGE__->register_method(
 166         method  => "biblio_search_tcn",
 167         api_name        => "open-ils.search.biblio.tcn",
 168         argc            => 3,
 169         note            => "Retrieve a record by TCN",
 170 );
 171
 172 sub biblio_search_tcn {
 173
 174         my( $self, $client, $tcn ) = @_;
 175
 176         $tcn =~ s/.*?(\w+)\s*$/$1/o;
 177
 178         my $e = new_editor();
 179         my $recs = $e->search_biblio_record_entry(
 180                 {deleted => 'f', tcn_value => $tcn}, {idlist =>1});
 181
 182         return { count => scalar(@$recs), ids => $recs };
 183 }
 184
 185
 186 # --------------------------------------------------------------------------------
 187
 188 __PACKAGE__->register_method(
 189         method  => "biblio_barcode_to_copy",
 190         api_name        => "open-ils.search.asset.copy.find_by_barcode",);
 191 sub biblio_barcode_to_copy {
 192         my( $self, $client, $barcode ) = @_;
 193         my( $copy, $evt ) = $U->fetch_copy_by_barcode($barcode);
 194         return $evt if $evt;
 195         return $copy;
 196 }
 197
 198 __PACKAGE__->register_method(
 199         method  => "biblio_id_to_copy",
 200         api_name        => "open-ils.search.asset.copy.batch.retrieve",);
 201 sub biblio_id_to_copy {
 202         my( $self, $client, $ids ) = @_;
 203         $logger->info("Fetching copies @$ids");
 204         return $U->storagereq(
 205                 "open-ils.storage.direct.asset.copy.batch.retrieve.atomic", @$ids );
 206 }
 207
 208
 209 __PACKAGE__->register_method(
 210         method  => "copy_retrieve",
 211         api_name        => "open-ils.search.asset.copy.retrieve",);
 212 sub copy_retrieve {
 213         my( $self, $client, $cid ) = @_;
 214         my( $copy, $evt ) = $U->fetch_copy($cid);
 215         return $evt if $evt;
 216         return $copy;
 217 }
 218
 219 __PACKAGE__->register_method(
 220         method  => "volume_retrieve",
 221         api_name        => "open-ils.search.asset.call_number.retrieve");
 222 sub volume_retrieve {
 223         my( $self, $client, $vid ) = @_;
 224         my $e = new_editor();
 225         my $vol = $e->retrieve_asset_call_number($vid) or return $e->event;
 226         return $vol;
 227 }
 228
 229 __PACKAGE__->register_method(
 230         method  => "fleshed_copy_retrieve_batch",
 231         api_name        => "open-ils.search.asset.copy.fleshed.batch.retrieve");
 232
 233 sub fleshed_copy_retrieve_batch {
 234         my( $self, $client, $ids ) = @_;
 235         $logger->info("Fetching fleshed copies @$ids");
 236         return $U->storagereq(
 237                 "open-ils.storage.fleshed.asset.copy.batch.retrieve.atomic", @$ids );
 238 }
 239
 240
 241 __PACKAGE__->register_method(
 242         method  => "fleshed_copy_retrieve",
 243         api_name        => "open-ils.search.asset.copy.fleshed.retrieve",);
 244
 245 sub fleshed_copy_retrieve {
 246         my( $self, $client, $id ) = @_;
 247         my( $c, $e) = $U->fetch_fleshed_copy($id);
 248         return $e if $e;
 249         return $c;
 250 }
 251
 252
 253
 254 __PACKAGE__->register_method(
 255         method  => "biblio_barcode_to_title",
 256         api_name        => "open-ils.search.biblio.find_by_barcode",
 257 );
 258
 259 sub biblio_barcode_to_title {
 260         my( $self, $client, $barcode ) = @_;
 261
 262         my $title = $apputils->simple_scalar_request(
 263                 "open-ils.storage",
 264                 "open-ils.storage.biblio.record_entry.retrieve_by_barcode", $barcode );
 265
 266         return { ids => [ $title->id ], count => 1 } if $title;
 267         return { count => 0 };
 268 }
 269
 270
 271 __PACKAGE__->register_method(
 272         method  => "biblio_copy_to_mods",
 273         api_name        => "open-ils.search.biblio.copy.mods.retrieve",
 274 );
 275
 276 # takes a copy object and returns it fleshed mods object
 277 sub biblio_copy_to_mods {
 278         my( $self, $client, $copy ) = @_;
 279
 280         my $volume = $U->storagereq(
 281                 "open-ils.storage.direct.asset.call_number.retrieve",
 282                 $copy->call_number() );
 283
 284         my $mods = _records_to_mods($volume->record());
 285         $mods = shift @$mods;
 286         $volume->copies([$copy]);
 287         push @{$mods->call_numbers()}, $volume;
 288
 289         return $mods;
 290 }
 291
 292
 293 # ----------------------------------------------------------------------------
 294 # These are the main OPAC search methods
 295 # ----------------------------------------------------------------------------
 296
 297 __PACKAGE__->register_method(
 298         method          => 'the_quest_for_knowledge',
 299         api_name                => 'open-ils.search.biblio.multiclass',
 300         signature       => q/
 301                 Performs a multi class bilbli or metabib search
 302                 @param searchhash A search object layed out like so:
 303                         searches : { "$class" : "$value", ...}
 304                         org_unit : The org id to focus the search at
 305                         depth           : The org depth
 306                         limit           : The search limit
 307                         offset  : The search offset
 308                         format  : The MARC format
 309                         sort            : What field to sort the results on [ author | title | pubdate ]
 310                         sort_dir        : What direction do we sort? [ asc | desc ]
 311                 @return An object of the form
 312                         { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }
 313         /
 314 );
 315
 316 __PACKAGE__->register_method(
 317         method          => 'the_quest_for_knowledge',
 318         api_name                => 'open-ils.search.biblio.multiclass.staff',
 319         signature       => q/@see open-ils.search.biblio.multiclass/);
 320 __PACKAGE__->register_method(
 321         method          => 'the_quest_for_knowledge',
 322         api_name                => 'open-ils.search.metabib.multiclass',
 323         signature       => q/@see open-ils.search.biblio.multiclass/);
 324 __PACKAGE__->register_method(
 325         method          => 'the_quest_for_knowledge',
 326         api_name                => 'open-ils.search.metabib.multiclass.staff',
 327         signature       => q/@see open-ils.search.biblio.multiclass/);
 328
 329
 330
 331 sub the_quest_for_knowledge {
 332         my( $self, $conn, $searchhash ) = @_;
 333
 334         return { count => 0 } unless $searchhash and
 335                 ref $searchhash->{searches} eq 'HASH';
 336
 337         my $method = 'open-ils.storage.biblio.multiclass.search_fts';
 338         my $ismeta = 0;
 339         my @recs;
 340
 341
 342         my $offset      = $searchhash->{offset} || 0;
 343         my $limit       = $searchhash->{limit} || 10;
 344         my $end         = $offset + $limit - 1;
 345
 346         my $maxlimit = 5000;
 347         $searchhash->{offset}   = 0;
 348         $searchhash->{limit}            = $maxlimit;
 349
 350         my @search;
 351         push( @search, ($_ => $$searchhash{$_})) for (sort keys %$searchhash);
 352         my $ckey = $pfx . md5_hex($method . JSON->perl2JSON(\@search));
 353
 354         $searchhash->{limit} -= $offset;
 355
 356         if($self->api_name =~ /metabib/) {
 357                 $ismeta = 1;
 358                 $method =~ s/biblio/metabib/o;
 359         }
 360
 361         # don't cache past max limit
 362         my $result = ($end < $searchhash->{limit}) ?
 363                 search_cache($ckey, $offset, $limit) : undef;
 364         my $docache = 1;
 365
 366         if(!$result) {
 367
 368                 $method .= ".staff" if($self->api_name =~ /staff/);
 369                 $method .= ".atomic";
 370
 371                 for (keys %$searchhash) {
 372                         delete $$searchhash{$_} unless defined $$searchhash{$_}; }
 373
 374                 #$searchhash->{limit} = $maxlimit;
 375
 376                 my $err;
 377                 my $errstr;
 378
 379                 try {
 380                         $result = $U->storagereq( $method, %$searchhash );
 381
 382                 } catch Error with {
 383                         my $err = shift;
 384
 385                         my $errstr = "Multiclass search failed.  Args = " .
 386                                 JSON->perl2JSON($searchhash) . "\nError = $err";
 387
 388                         $logger->error($errstr);
 389                         warn "$errstr\n";
 390                 };
 391
 392                 throw $err ($errstr) if $err;
 393
 394
 395         } else {
 396                 $docache = 0;
 397         }
 398
 399         return {count => 0} unless ($result && $$result[0]);
 400
 401         for my $r (@$result) { push(@recs, $r) if ($r and $$r[0]); }
 402
 403
 404         if( $docache and ($end < $maxlimit) ) {
 405                 # If we didn't get this data from the cache, put it into the cache
 406                 # then return the correct offset of records
 407                 $logger->debug("putting search cache $ckey\n");
 408                 put_cache($ckey, \@recs);
 409
 410                 my @t;
 411                 for ($offset..$end) {
 412                         last if $end > scalar(@recs);
 413                         push(@t, $recs[$_]) if $recs[$_];
 414                 }
 415                 @recs = @t;
 416
 417                 #$logger->debug("cache done .. returning $offset..$end : " . JSON->perl2JSON(\@recs));
 418         }
 419
 420         return { ids => \@recs,
 421                 count => ($ismeta) ? $result->[0]->[3] : $result->[0]->[2] };
 422 }
 423
 424
 425
 426 sub search_cache {
 427
 428         my $key         = shift;
 429         my $offset      = shift;
 430         my $limit       = shift;
 431
 432
 433         my $start = $offset;
 434         my $end = $offset + $limit - 1;
 435
 436         $logger->debug("searching cache for $key : $start..$end\n");
 437
 438         return undef unless $cache;
 439         my $data = $cache->get_cache($key);
 440
 441         return undef unless $data and ref $data eq 'ARRAY' and $$data[$start] and $$data[$end];
 442
 443         #$logger->debug("search_cache found data " . JSON->perl2JSON($data));
 444         $logger->debug("search_cache found data for indices $start..$end");
 445
 446         my $result = [ (@$data[$start..$end]) ];
 447
 448         $logger->debug("cache returning results: [".
 449                 JSON->perl2JSON($$result[0]) . '...' .
 450                 JSON->perl2JSON($$result[$limit-1]) .']' );
 451
 452         return $result;
 453 }
 454
 455
 456 sub put_cache {
 457         my( $key, $data ) = @_;
 458         return undef unless $cache;
 459         $logger->debug("search_cache putting ".
 460                 scalar(@$data)." items at key $key with timeout $cache_timeout");
 461         $cache->put_cache($key, $data, $cache_timeout);
 462 }
 463
 464
 465
 466
 467
 468
 469 __PACKAGE__->register_method(
 470         method  => "biblio_mrid_to_modsbatch_batch",
 471         api_name        => "open-ils.search.biblio.metarecord.mods_slim.batch.retrieve");
 472
 473 sub biblio_mrid_to_modsbatch_batch {
 474         my( $self, $client, $mrids) = @_;
 475         warn "Performing mrid_to_modsbatch_batch...";
 476         my @mods;
 477         my $method = $self->method_lookup("open-ils.search.biblio.metarecord.mods_slim.retrieve");
 478         for my $id (@$mrids) {
 479                 next unless defined $id;
 480                 my ($m) = $method->run($id);
 481                 push @mods, $m;
 482         }
 483         return \@mods;
 484 }
 485
 486
 487 __PACKAGE__->register_method(
 488         method  => "biblio_mrid_to_modsbatch",
 489         api_name        => "open-ils.search.biblio.metarecord.mods_slim.retrieve",
 490         notes           => <<"  NOTES");
 491         Returns the mvr associated with a given metarecod. If none exists,
 492         it is created.
 493         NOTES
 494
 495 __PACKAGE__->register_method(
 496         method  => "biblio_mrid_to_modsbatch",
 497         api_name        => "open-ils.search.biblio.metarecord.mods_slim.retrieve.staff",
 498         notes           => <<"  NOTES");
 499         Returns the mvr associated with a given metarecod. If none exists,
 500         it is created.
 501         NOTES
 502
 503 sub biblio_mrid_to_modsbatch {
 504         my( $self, $client, $mrid ) = @_;
 505
 506         warn "Grabbing mvr for $mrid\n";
 507
 508         my ($mr, $evt) = _grab_metarecord($mrid);
 509         return $evt unless $mr;
 510
 511         if( my $m = $self->biblio_mrid_check_mvr($client, $mr)) {
 512                 return $m;
 513         }
 514
 515         return $self->biblio_mrid_make_modsbatch( $client, $mr );
 516 }
 517
 518 # converts a metarecord to an mvr
 519 sub _mr_to_mvr {
 520         my $mr = shift;
 521         my $perl = JSON->JSON2perl($mr->mods());
 522         return Fieldmapper::metabib::virtual_record->new($perl);
 523 }
 524
 525 # checks to see if a metarecord has mods, if so returns true;
 526
 527 __PACKAGE__->register_method(
 528         method  => "biblio_mrid_check_mvr",
 529         api_name        => "open-ils.search.biblio.metarecord.mods_slim.check",
 530         notes           => <<"  NOTES");
 531         Takes a metarecord ID or a metarecord object and returns true
 532         if the metarecord already has an mvr associated with it.
 533         NOTES
 534
 535 sub biblio_mrid_check_mvr {
 536         my( $self, $client, $mrid ) = @_;
 537         my $mr;
 538
 539         my $evt;
 540         if(ref($mrid)) { $mr = $mrid; }
 541         else { ($mr, $evt) = _grab_metarecord($mrid); }
 542         return $evt if $evt;
 543
 544         warn "Checking mvr for mr " . $mr->id . "\n";
 545
 546         return _mr_to_mvr($mr) if $mr->mods();
 547         return undef;
 548 }
 549
 550 sub _grab_metarecord {
 551         my $mrid = shift;
 552         #my $e = OpenILS::Utils::Editor->new;
 553         my $e = new_editor();
 554         my $mr = $e->retrieve_metabib_metarecord($mrid) or return ( undef, $e->event );
 555         return ($mr);
 556 }
 557
 558
 559 __PACKAGE__->register_method(
 560         method  => "biblio_mrid_make_modsbatch",
 561         api_name        => "open-ils.search.biblio.metarecord.mods_slim.create",
 562         notes           => <<"  NOTES");
 563         Takes either a metarecord ID or a metarecord object.
 564         Forces the creations of an mvr for the given metarecord.
 565         The created mvr is returned.
 566         NOTES
 567
 568 sub biblio_mrid_make_modsbatch {
 569         my( $self, $client, $mrid ) = @_;
 570
 571         #my $e = OpenILS::Utils::Editor->new;
 572         my $e = new_editor();
 573
 574         my $mr;
 575         if( ref($mrid) ) {
 576                 $mr = $mrid;
 577                 $mrid = $mr->id;
 578         } else {
 579                 $mr = $e->retrieve_metabib_metarecord($mrid)
 580                         or return $e->event;
 581         }
 582
 583         my $masterid = $mr->master_record;
 584         $logger->info("creating new mods batch for metarecord=$mrid, master record=$masterid");
 585
 586         my $ids = $U->storagereq(
 587                 'open-ils.storage.ordered.metabib.metarecord.records.staff.atomic', $mrid);
 588         return undef unless @$ids;
 589
 590         my $master = $e->retrieve_biblio_record_entry($masterid)
 591                 or return $e->event;
 592
 593         # start the mods batch
 594         my $u = OpenILS::Utils::ModsParser->new();
 595         $u->start_mods_batch( $master->marc );
 596
 597         # grab all of the sub-records and shove them into the batch
 598         my @ids = grep { $_ ne $masterid } @$ids;
 599         my $subrecs = $e->batch_retrieve_biblio_record_entry(\@ids);
 600
 601         for(@$subrecs) {
 602                 $logger->debug("adding record ".$_->id." to mods batch for metarecord=$mrid");
 603                 $u->push_mods_batch( $_->marc ) if $_->marc;
 604         }
 605
 606
 607         # finish up and send to the client
 608         my $mods = $u->finish_mods_batch();
 609         $mods->doc_id($mrid);
 610         $client->respond_complete($mods);
 611
 612
 613         # now update the mods string in the db
 614         my $string = JSON->perl2JSON($mods->decast);
 615         $mr->mods($string);
 616
 617         #$e = OpenILS::Utils::Editor->new(xact => 1);
 618         $e = new_editor(xact => 1);
 619         $e->update_metabib_metarecord($mr)
 620                 or $logger->error("Error setting mods text on metarecord $mrid : " . Dumper($e->event));
 621         $e->finish;
 622
 623         return undef;
 624 }
 625
 626
 627
 628
 629 # converts a mr id into a list of record ids
 630
 631 __PACKAGE__->register_method(
 632         method  => "biblio_mrid_to_record_ids",
 633         api_name        => "open-ils.search.biblio.metarecord_to_records",
 634 );
 635
 636 __PACKAGE__->register_method(
 637         method  => "biblio_mrid_to_record_ids",
 638         api_name        => "open-ils.search.biblio.metarecord_to_records.staff",
 639 );
 640
 641 sub biblio_mrid_to_record_ids {
 642         my( $self, $client, $mrid, $args ) = @_;
 643
 644         my $format      = $$args{format};
 645         my $org         = $$args{org};
 646         my $depth       = $$args{depth};
 647
 648         my $method = "open-ils.storage.ordered.metabib.metarecord.records.atomic";
 649         $method =~ s/atomic/staff\.atomic/o if $self->api_name =~ /staff/o;
 650         my $recs = $U->storagereq($method, $mrid, $format, $org, $depth);
 651
 652         return { count => scalar(@$recs), ids => $recs };
 653 }
 654
 655
 656 __PACKAGE__->register_method(
 657         method  => "biblio_record_to_marc_html",
 658         api_name        => "open-ils.search.biblio.record.html" );
 659
 660 my $parser              = XML::LibXML->new();
 661 my $xslt                        = XML::LibXSLT->new();
 662 my $marc_sheet;
 663
 664 my $settings_client = OpenSRF::Utils::SettingsClient->new();
 665 sub biblio_record_to_marc_html {
 666         my( $self, $client, $recordid ) = @_;
 667
 668         if( !$marc_sheet ) {
 669                 my $dir = $settings_client->config_value( "dirs", "xsl" );
 670                 my $xsl = $settings_client->config_value(
 671                         "apps", "open-ils.search", "app_settings", "marc_html_xsl" );
 672
 673                 $xsl = $parser->parse_file("$dir/$xsl");
 674                 $marc_sheet = $xslt->parse_stylesheet( $xsl );
 675         }
 676
 677
 678         my $record = $apputils->simple_scalar_request(
 679                 "open-ils.storage",
 680                 "open-ils.storage.direct.biblio.record_entry.retrieve",
 681                 $recordid );
 682
 683         my $xmldoc = $parser->parse_string($record->marc);
 684         my $html = $marc_sheet->transform($xmldoc);
 685         $html = $html->toString();
 686         return $html;
 687
 688 }
 689
 690
 691 =head duplicate
 692 __PACKAGE__->register_method(
 693         method  => "retrieve_all_copy_locations",
 694         api_name        => "open-ils.search.config.copy_location.retrieve.all" );
 695
 696 my $shelving_locations;
 697 sub retrieve_all_copy_locations {
 698         my( $self, $client ) = @_;
 699         if(!$shelving_locations) {
 700                 $shelving_locations = $apputils->simple_scalar_request(
 701                         "open-ils.storage",
 702                         "open-ils.storage.direct.asset.copy_location.retrieve.all.atomic");
 703         }
 704         return $shelving_locations;
 705 }
 706 =cut
 707
 708
 709
 710 __PACKAGE__->register_method(
 711         method  => "retrieve_all_copy_statuses",
 712         api_name        => "open-ils.search.config.copy_status.retrieve.all" );
 713
 714 my $copy_statuses;
 715 sub retrieve_all_copy_statuses {
 716         my( $self, $client ) = @_;
 717         return $copy_statuses if $copy_statuses;
 718         return $copy_statuses =
 719                 new_editor()->retrieve_all_config_copy_status();
 720 }
 721
 722
 723 __PACKAGE__->register_method(
 724         method  => "copy_counts_per_org",
 725         api_name        => "open-ils.search.biblio.copy_counts.retrieve");
 726
 727 __PACKAGE__->register_method(
 728         method  => "copy_counts_per_org",
 729         api_name        => "open-ils.search.biblio.copy_counts.retrieve.staff");
 730
 731 sub copy_counts_per_org {
 732         my( $self, $client, $record_id ) = @_;
 733
 734         warn "Retreiveing copy copy counts for record $record_id and method " . $self->api_name . "\n";
 735
 736         my $method = "open-ils.storage.biblio.record_entry.global_copy_count.atomic";
 737         if($self->api_name =~ /staff/) { $method =~ s/atomic/staff\.atomic/; }
 738
 739         my $counts = $apputils->simple_scalar_request(
 740                 "open-ils.storage", $method, $record_id );
 741
 742         $counts = [ sort {$a->[0] <=> $b->[0]} @$counts ];
 743         return $counts;
 744 }
 745
 746
 747 __PACKAGE__->register_method(
 748         method          => "copy_count_summary",
 749         api_name        => "open-ils.search.biblio.copy_counts.summary.retrieve",
 750         notes           => <<"  NOTES");
 751         returns an array of these:
 752                 [ org_id, callnumber_label, <status1_count>, <status2_cout>,...]
 753                 where statusx is a copy status name.  the statuses are sorted
 754                 by id.
 755         NOTES
 756
 757 sub copy_count_summary {
 758         my( $self, $client, $rid, $org, $depth ) = @_;
 759         $org ||= 1;
 760         $depth ||= 0;
 761         return $U->storagereq(
 762                 'open-ils.storage.biblio.record_entry.status_copy_count.atomic', $rid, $org, $depth );
 763 }
 764
 765
 766
 767 =head
 768 __PACKAGE__->register_method(
 769         method          => "multiclass_search",
 770         api_name        => "open-ils.search.biblio.multiclass",
 771         notes           => <<"  NOTES");
 772                 Performs a multiclass search
 773                 PARAMS( searchBlob, org_unit, format, limit )
 774                 where searchBlob is defined like this:
 775                         {
 776                                 "title" : { "term" : "water" },
 777                                 "author" : { "term" : "smith" },
 778                                 ...
 779                         }
 780         NOTES
 781
 782 __PACKAGE__->register_method(
 783         method          => "multiclass_search",
 784         api_name        => "open-ils.search.biblio.multiclass.staff",
 785         notes           => "see open-ils.search.biblio.multiclass" );
 786
 787 sub multiclass_search {
 788         my( $self, $client, $searchBlob, $orgid, $format, $limit ) = @_;
 789
 790         $logger->debug("Performing multiclass search with org => $orgid, " .
 791                 "format => $format, limit => $limit, and search blob " . Dumper($searchBlob));
 792
 793         my $meth = 'open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.atomic';
 794         if($self->api_name =~ /staff/) { $meth =~ s/metarecord\.atomic/metarecord.staff.atomic/; }
 795
 796
 797         my $records = $apputils->simplereq(
 798                 'open-ils.storage', $meth,
 799                  org_unit => $orgid, searches => $searchBlob, format => $format, limit => $limit );
 800
 801         my $count = 0;
 802         my $recs = [];
 803
 804         if( ref($records) and $records->[0] and
 805                 defined($records->[0]->[3])) { $count = $records->[0]->[3];}
 806
 807         for my $r (@$records) { push( @$recs, $r ) if ($r and $r->[0]); }
 808
 809         # records has the form: [ mrid, rank, singleRecord / 0, hitCount ];
 810         return { ids => $recs, count => $count };
 811 }
 812 =cut
 813
 814
 815 =head comment-1
 816 __PACKAGE__->register_method(
 817         method          => "multiclass_search",
 818         api_name                => "open-ils.search.biblio.multiclass",
 819         signature       => q/
 820                 Performs a multiclass search
 821                 @param args A names hash of arguments:
 822                         org_unit : The org to focus the search on
 823                         depth           : The search depth
 824                         format  : Item format
 825                         limit           : Return limit
 826                         offset  : Search offset
 827                         searches : A named hash of searches which has the following format:
 828                                 {
 829                                         "title" : { "term" : "water" },
 830                                         "author" : { "term" : "smith" },
 831                                         ...
 832                                 }
 833                 @return { ids : <array of ids>, count : hitcount }
 834         /
 835 );
 836
 837 __PACKAGE__->register_method(
 838         method          => "multiclass_search",
 839         api_name                => "open-ils.search.biblio.multiclass.staff",
 840         notes           => q/@see open-ils.search.biblio.multiclass/ );
 841
 842 sub multiclass_search {
 843         my( $self, $client, $args ) = @_;
 844
 845         $logger->debug("Performing multiclass search with args:\n" . Dumper($args));
 846         my $meth = 'open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.atomic';
 847         if($self->api_name =~ /staff/) { $meth =~ s/metarecord\.atomic/metarecord.staff.atomic/; }
 848
 849         my $records = $apputils->simplereq( 'open-ils.storage', $meth, %$args );
 850
 851         my $count = 0;
 852         my $recs = [];
 853
 854         if( ref($records) and $records->[0] and
 855                 defined($records->[0]->[3])) { $count = $records->[0]->[3];}
 856
 857         for my $r (@$records) { push( @$recs, $r ) if ($r and $r->[0]); }
 858
 859         return { ids => $recs, count => $count };
 860 }
 861
 862 =cut
 863
 864
 865
 866 __PACKAGE__->register_method(
 867         method          => "marc_search",
 868         api_name        => "open-ils.search.biblio.marc.staff");
 869
 870 __PACKAGE__->register_method(
 871         method          => "marc_search",
 872         api_name        => "open-ils.search.biblio.marc",
 873         notes           => <<"  NOTES");
 874                 Example:
 875                 open-ils.storage.biblio.full_rec.multi_search.atomic
 876                 { "searches": [{"term":"harry","restrict": [{"tag":245,"subfield":"a"}]}], "org_unit": 1,
 877         "limit":5,"sort":"author","item_type":"g"}
 878         NOTES
 879
 880 sub marc_search {
 881         my( $self, $conn, $args, $limit, $offset ) = @_;
 882
 883         my $method = 'open-ils.storage.biblio.full_rec.multi_search';
 884         $method .= ".staff" if $self->api_name =~ /staff/;
 885         $method .= ".atomic";
 886
 887         $limit ||= 10;
 888         $offset ||= 0;
 889
 890         my @search;
 891         push( @search, ($_ => $$args{$_}) ) for (sort keys %$args);
 892         my $ckey = $pfx . md5_hex($method . JSON->perl2JSON(\@search));
 893
 894         my $recs = search_cache($ckey, $offset, $limit);
 895
 896         if(!$recs) {
 897                 $recs = new_editor()->request($method, %$args);
 898                 put_cache($ckey, $recs);
 899                 $recs = [ @$recs[$offset..($offset + ($limit - 1))] ];
 900         }
 901
 902         my $count = 0;
 903         $count = $recs->[0]->[2] if $recs->[0] and $recs->[0]->[2];
 904         my @recs = map { $_->[0] } @$recs;
 905
 906         return { ids => \@recs, count => $count };
 907 }
 908
 909
 910 __PACKAGE__->register_method(
 911         method  => "biblio_search_isbn",
 912         api_name        => "open-ils.search.biblio.isbn",
 913 );
 914
 915 sub biblio_search_isbn {
 916         my( $self, $client, $isbn ) = @_;
 917         $logger->debug("Searching ISBN $isbn");
 918         my $e = new_editor();
 919         my $recs = $U->storagereq(
 920                 'open-ils.storage.id_list.biblio.record_entry.search.isbn.atomic', $isbn );
 921         return { ids => $recs, count => scalar(@$recs) };
 922 }
 923
 924
 925 __PACKAGE__->register_method(
 926         method  => "biblio_search_issn",
 927         api_name        => "open-ils.search.biblio.issn",
 928 );
 929
 930 sub biblio_search_issn {
 931         my( $self, $client, $issn ) = @_;
 932         $logger->debug("Searching ISSN $issn");
 933         my $e = new_editor();
 934         my $recs = $U->storagereq(
 935                 'open-ils.storage.id_list.biblio.record_entry.search.issn.atomic', $issn );
 936         return { ids => $recs, count => scalar(@$recs) };
 937 }
 938
 939
 940
 941
 942 __PACKAGE__->register_method(
 943         method  => "fetch_mods_by_copy",
 944         api_name        => "open-ils.search.biblio.mods_from_copy",
 945 );
 946
 947 sub fetch_mods_by_copy {
 948         my( $self, $client, $copyid ) = @_;
 949         my ($record, $evt) = $apputils->fetch_record_by_copy( $copyid );
 950         return $evt if $evt;
 951         return OpenILS::Event->new('ITEM_NOT_CATALOGED') unless $record->marc;
 952         return $apputils->record_to_mvr($record);
 953 }
 954
 955
 956
 957 # -------------------------------------------------------------------------------------
 958
 959 __PACKAGE__->register_method(
 960         method  => "cn_browse",
 961         api_name        => "open-ils.search.callnumber.browse.target",
 962         notes           => "Starts a callnumber browse"
 963         );
 964
 965 __PACKAGE__->register_method(
 966         method  => "cn_browse",
 967         api_name        => "open-ils.search.callnumber.browse.page_up",
 968         notes           => "Returns the previous page of callnumbers",
 969         );
 970
 971 __PACKAGE__->register_method(
 972         method  => "cn_browse",
 973         api_name        => "open-ils.search.callnumber.browse.page_down",
 974         notes           => "Returns the next page of callnumbers",
 975         );
 976
 977
 978 # RETURNS array of arrays like so: label, owning_lib, record, id
 979 sub cn_browse {
 980         my( $self, $client, @params ) = @_;
 981         my $method;
 982
 983         $method = 'open-ils.storage.asset.call_number.browse.target.atomic'
 984                 if( $self->api_name =~ /target/ );
 985         $method = 'open-ils.storage.asset.call_number.browse.page_up.atomic'
 986                 if( $self->api_name =~ /page_up/ );
 987         $method = 'open-ils.storage.asset.call_number.browse.page_down.atomic'
 988                 if( $self->api_name =~ /page_down/ );
 989
 990         return $apputils->simplereq( 'open-ils.storage', $method, @params );
 991 }
 992 # -------------------------------------------------------------------------------------
 993
 994 __PACKAGE__->register_method(
 995         method => "fetch_cn",
 996         api_name => "open-ils.search.callnumber.retrieve",
 997         notes           => "retrieves a callnumber based on ID",
 998         );
 999
1000 sub fetch_cn {
1001         my( $self, $client, $id ) = @_;
1002         my( $cn, $evt ) = $apputils->fetch_callnumber( $id );
1003         return $evt if $evt;
1004         return $cn;
1005 }
1006
1007 __PACKAGE__->register_method (
1008         method          => "fetch_copy_by_cn",
1009         api_name                => 'open-ils.search.copies_by_call_number.retrieve',
1010         signature       => q/
1011                 Returns an array of copy id's by callnumber id
1012                 @param cnid The callnumber id
1013                 @return An array of copy ids
1014         /
1015 );
1016
1017 sub fetch_copy_by_cn {
1018         my( $self, $conn, $cnid ) = @_;
1019         return $U->storagereq(
1020                 'open-ils.storage.id_list.asset.copy.search_where.atomic',
1021                 { call_number => $cnid, deleted => 'f' } );
1022 }
1023
1024 __PACKAGE__->register_method (
1025         method          => 'fetch_cn_by_info',
1026         api_name                => 'open-ils.search.call_number.retrieve_by_info',
1027         signature       => q/
1028                 @param label The callnumber label
1029                 @param record The record the cn is attached to
1030                 @param org The owning library of the cn
1031                 @return The callnumber object
1032         /
1033 );
1034
1035
1036 sub fetch_cn_by_info {
1037         my( $self, $conn, $label, $record, $org ) = @_;
1038         return $U->storagereq(
1039                 'open-ils.storage.direct.asset.call_number.search_where',
1040                 { label => $label, record => $record, owning_lib => $org, deleted => 'f' });
1041 }
1042
1043
1044
1045
1046
1047 __PACKAGE__->register_method (
1048         method => 'bib_extras',
1049         api_name => 'open-ils.search.biblio.lit_form_map.retrieve.all');
1050 __PACKAGE__->register_method (
1051         method => 'bib_extras',
1052         api_name => 'open-ils.search.biblio.item_form_map.retrieve.all');
1053 __PACKAGE__->register_method (
1054         method => 'bib_extras',
1055         api_name => 'open-ils.search.biblio.item_type_map.retrieve.all');
1056 __PACKAGE__->register_method (
1057         method => 'bib_extras',
1058         api_name => 'open-ils.search.biblio.audience_map.retrieve.all');
1059
1060 sub bib_extras {
1061         my $self = shift;
1062
1063         my $e = new_editor();
1064
1065         return $e->retrieve_all_config_lit_form_map()
1066                 if( $self->api_name =~ /lit_form/ );
1067
1068         return $e->retrieve_all_config_item_form_map()
1069                 if( $self->api_name =~ /item_form_map/ );
1070
1071         return $e->retrieve_all_config_item_type_map()
1072                 if( $self->api_name =~ /item_type_map/ );
1073
1074         return $e->retrieve_all_config_audience_map()
1075                 if( $self->api_name =~ /audience_map/ );
1076
1077         return [];
1078 }
1079
1080
1081
1082 __PACKAGE__->register_method(
1083         method  => 'fetch_slim_record',
1084         api_name        => 'open-ils.search.biblio.record_entry.slim.retrieve',
1085         signature=> q/
1086                 Returns a biblio.record_entry without the attached marcxml
1087         /
1088 );
1089
1090 sub fetch_slim_record {
1091         my( $self, $conn, $ids ) = @_;
1092
1093         #my $editor = OpenILS::Utils::Editor->new;
1094         my $editor = new_editor();
1095         my @res;
1096         for( @$ids ) {
1097                 return $editor->event unless
1098                         my $r = $editor->retrieve_biblio_record_entry($_);
1099                 $r->clear_marc;
1100                 push(@res, $r);
1101         }
1102         return \@res;
1103 }
1104
1105
1106
1107 __PACKAGE__->register_method(
1108         method => 'rec_to_mr_rec_descriptors',
1109         api_name        => 'open-ils.search.metabib.record_to_descriptors',
1110         signature       => q/
1111                 specialized method...
1112                 Given a biblio record id or a metarecord id,
1113                 this returns a list of metabib.record_descriptor
1114                 objects that live within the same metarecord
1115                 @param args Object of args including:
1116         /
1117 );
1118
1119 sub rec_to_mr_rec_descriptors {
1120         my( $self, $conn, $args ) = @_;
1121
1122         my $rec = $$args{record};
1123         my $mrec        = $$args{metarecord};
1124         my $item_forms = $$args{item_forms};
1125         my $item_types  = $$args{item_types};
1126         my $item_lang   = $$args{item_lang};
1127
1128         my $e = new_editor();
1129         my $recs;
1130
1131         if( !$mrec ) {
1132                 my $map = $e->search_metabib_metarecord_source_map({source => $rec});
1133                 return $e->event unless @$map;
1134                 $mrec = $$map[0]->metarecord;
1135         }
1136
1137         $recs = $e->search_metabib_metarecord_source_map({metarecord => $mrec});
1138         return $e->event unless @$recs;
1139
1140         my @recs = map { $_->source } @$recs;
1141         my $search = { record => \@recs };
1142         $search->{item_form} = $item_forms if $item_forms and @$item_forms;
1143         $search->{item_type} = $item_types if $item_types and @$item_types;
1144         $search->{item_lang} = $item_lang if $item_lang;
1145
1146         my $desc = $e->search_metabib_record_descriptor($search);
1147
1148         return { metarecord => $mrec, descriptors => $desc };
1149 }
1150
1151
1152
1153
1154 __PACKAGE__->register_method(
1155         method => 'copies_created_on',
1156 );
1157
1158
1159 sub copies_created_on {
1160         my( $self, $conn, $auth, $org, $date ) = @_;
1161         my $e = new_editor(authtoken=>$auth);
1162         return $e->event unless $e->checkauth;
1163 }
1164
1165
1166 1;
1167
1168