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.cstore");
  58         my $request = $session->request(
  59                         "open-ils.cstore.direct.biblio.record_entry.search", { id => \@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->cstorereq(
 205                 "open-ils.cstore.direct.asset.copy.search.atomic", { id => $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->cstorereq(
 237                 "open-ils.cstore.direct.asset.copy.search.atomic",
 238                 { id => $ids },
 239                 { flesh => 1,
 240                   flesh_fields => { acp => [ qw/ circ_lib location status stat_cat_entries / ] }
 241                 });
 242 }
 243
 244
 245 __PACKAGE__->register_method(
 246         method  => "fleshed_copy_retrieve",
 247         api_name        => "open-ils.search.asset.copy.fleshed.retrieve",);
 248
 249 sub fleshed_copy_retrieve {
 250         my( $self, $client, $id ) = @_;
 251         my( $c, $e) = $U->fetch_fleshed_copy($id);
 252         return $e if $e;
 253         return $c;
 254 }
 255
 256 __PACKAGE__->register_method(
 257         method  => "fleshed_copy_retrieve2",
 258         api_name        => "open-ils.search.asset.copy.fleshed2.retrieve",);
 259
 260 sub fleshed_copy_retrieve2 {
 261         my( $self, $client, $id ) = @_;
 262         my $e = new_editor();
 263         my $copy = $e->retrieve_asset_copy(
 264                 [
 265                         $id,
 266                         {
 267                                 flesh                           => 2,
 268                                 flesh_fields    => {
 269                                         acp => [ qw/ location status stat_cat_entry_copy_maps notes age_protect / ],
 270                                         ascecm => [ qw/ stat_cat stat_cat_entry / ],
 271                                 }
 272                         }
 273                 ]
 274         ) or return $e->event;
 275
 276         # For backwards compatibility
 277         $copy->stat_cat_entries($copy->stat_cat_entry_copy_maps);
 278
 279         return $copy;
 280
 281 #       return $copy unless $copy->stat_cat_entries;
 282 #
 283 #       for my $map (@{$copy->stat_cat_entries}) {
 284 #               $map->stat_cat(
 285 #                       $e->retrieve_asset_stat_cat($map->stat_cat));
 286 #               $map->stat_cat_entry(
 287 #                       $e->retrieve_asset_stat_cat_entry($map->stat_cat_entry));
 288 #       }
 289 #       return $copy;
 290
 291 }
 292
 293
 294
 295
 296
 297 __PACKAGE__->register_method(
 298         method  => "biblio_barcode_to_title",
 299         api_name        => "open-ils.search.biblio.find_by_barcode",
 300 );
 301
 302 sub biblio_barcode_to_title {
 303         my( $self, $client, $barcode ) = @_;
 304
 305         my $title = $apputils->simple_scalar_request(
 306                 "open-ils.storage",
 307                 "open-ils.storage.biblio.record_entry.retrieve_by_barcode", $barcode );
 308
 309         return { ids => [ $title->id ], count => 1 } if $title;
 310         return { count => 0 };
 311 }
 312
 313
 314 __PACKAGE__->register_method(
 315         method  => "biblio_copy_to_mods",
 316         api_name        => "open-ils.search.biblio.copy.mods.retrieve",
 317 );
 318
 319 # takes a copy object and returns it fleshed mods object
 320 sub biblio_copy_to_mods {
 321         my( $self, $client, $copy ) = @_;
 322
 323         my $volume = $U->cstorereq(
 324                 "open-ils.cstore.direct.asset.call_number.retrieve",
 325                 $copy->call_number() );
 326
 327         my $mods = _records_to_mods($volume->record());
 328         $mods = shift @$mods;
 329         $volume->copies([$copy]);
 330         push @{$mods->call_numbers()}, $volume;
 331
 332         return $mods;
 333 }
 334
 335
 336 # ----------------------------------------------------------------------------
 337 # These are the main OPAC search methods
 338 # ----------------------------------------------------------------------------
 339
 340 __PACKAGE__->register_method(
 341         method          => 'the_quest_for_knowledge',
 342         api_name                => 'open-ils.search.biblio.multiclass',
 343         signature       => q/
 344                 Performs a multi class bilbli or metabib search
 345                 @param searchhash A search object layed out like so:
 346                         searches : { "$class" : "$value", ...}
 347                         org_unit : The org id to focus the search at
 348                         depth           : The org depth
 349                         limit           : The search limit
 350                         offset  : The search offset
 351                         format  : The MARC format
 352                         sort            : What field to sort the results on [ author | title | pubdate ]
 353                         sort_dir        : What direction do we sort? [ asc | desc ]
 354                 @return An object of the form
 355                         { "count" : $count, "ids" : [ [ $id, $relevancy, $total ], ...] }
 356         /
 357 );
 358
 359 __PACKAGE__->register_method(
 360         method          => 'the_quest_for_knowledge',
 361         api_name                => 'open-ils.search.biblio.multiclass.staff',
 362         signature       => q/@see open-ils.search.biblio.multiclass/);
 363 __PACKAGE__->register_method(
 364         method          => 'the_quest_for_knowledge',
 365         api_name                => 'open-ils.search.metabib.multiclass',
 366         signature       => q/@see open-ils.search.biblio.multiclass/);
 367 __PACKAGE__->register_method(
 368         method          => 'the_quest_for_knowledge',
 369         api_name                => 'open-ils.search.metabib.multiclass.staff',
 370         signature       => q/@see open-ils.search.biblio.multiclass/);
 371
 372
 373
 374 sub the_quest_for_knowledge {
 375         my( $self, $conn, $searchhash, $docache ) = @_;
 376
 377         return { count => 0 } unless $searchhash and
 378                 ref $searchhash->{searches} eq 'HASH';
 379
 380         my $method = 'open-ils.storage.biblio.multiclass.search_fts';
 381         my $ismeta = 0;
 382         my @recs;
 383
 384
 385         my $offset      = $searchhash->{offset} || 0;
 386         my $limit       = $searchhash->{limit} || 10;
 387         my $end         = $offset + $limit - 1;
 388
 389         for( keys %{$searchhash->{searches}} ) {
 390
 391         }
 392
 393         # do some simple sanity checking
 394         if(!$searchhash->{searches} or
 395                 (
 396                         !$searchhash->{searches}->{title}       and
 397                         !$searchhash->{searches}->{author}      and
 398                         !$searchhash->{searches}->{subject}     and
 399                         !$searchhash->{searches}->{series}      and
 400                         !$searchhash->{searches}->{keyword}     ) ) {
 401                 return { count => 0 };
 402         }
 403
 404
 405         my $maxlimit = 5000;
 406         $searchhash->{offset}   = 0;
 407         $searchhash->{limit}            = $maxlimit;
 408
 409         return { count => 0 } if $offset > $maxlimit;
 410
 411         my @search;
 412         push( @search, ($_ => $$searchhash{$_})) for (sort keys %$searchhash);
 413         my $s = JSON->perl2JSON(\@search);
 414         my $ckey = $pfx . md5_hex($method . $s);
 415
 416         $logger->info("bib search for: $s");
 417
 418         $searchhash->{limit} -= $offset;
 419
 420         if($self->api_name =~ /metabib/) {
 421                 $ismeta = 1;
 422                 $method =~ s/biblio/metabib/o;
 423         }
 424
 425         my $result = ($docache) ? search_cache($ckey, $offset, $limit) : undef;
 426
 427         if(!$result) {
 428
 429                 $method .= ".staff" if($self->api_name =~ /staff/);
 430                 $method .= ".atomic";
 431
 432                 for (keys %$searchhash) {
 433                         delete $$searchhash{$_}
 434                                 unless defined $$searchhash{$_};
 435                 }
 436
 437                 $result = $U->storagereq( $method, %$searchhash );
 438
 439         } else {
 440                 $docache = 0;
 441         }
 442
 443         return {count => 0} unless ($result && $$result[0]);
 444
 445         #for my $r (@$result) { push(@recs, $r) if ($r and $$r[0]); }
 446         @recs = @$result;
 447
 448         my $count = ($ismeta) ? $result->[0]->[3] : $result->[0]->[2];
 449
 450
 451         if( $docache ) {
 452
 453                 # If we didn't get this data from the cache, put it into the cache
 454                 # then return the correct offset of records
 455                 $logger->debug("putting search cache $ckey\n");
 456                 put_cache($ckey, $count, \@recs);
 457
 458                 my @t;
 459                 for ($offset..$end) {
 460                         last unless $recs[$_];
 461                         push(@t, $recs[$_]);
 462                 }
 463                 @recs = @t;
 464
 465                 #$logger->debug("cache done .. returning $offset..$end : " . JSON->perl2JSON(\@recs));
 466         }
 467
 468         return { ids => \@recs, count => $count };
 469 }
 470
 471
 472
 473 sub search_cache {
 474
 475         my $key         = shift;
 476         my $offset      = shift;
 477         my $limit       = shift;
 478         my $start       = $offset;
 479         my $end         = $offset + $limit - 1;
 480
 481         $logger->debug("searching cache for $key : $start..$end\n");
 482
 483         return undef unless $cache;
 484         my $data = $cache->get_cache($key);
 485
 486         return undef unless $data;
 487
 488         my $count = $data->[0];
 489         $data = $data->[1];
 490
 491         return undef unless $offset < $count;
 492
 493
 494         my @result;
 495         for( my $i = $offset; $i <= $end; $i++ ) {
 496                 last unless my $d = $$data[$i];
 497                 push( @result, $d );
 498         }
 499
 500         $logger->debug("search_cache found ".scalar(@result)." items for count=$count, start=$start, end=$end");
 501
 502         return \@result;
 503 }
 504
 505
 506 sub put_cache {
 507         my( $key, $count, $data ) = @_;
 508         return undef unless $cache;
 509         $logger->debug("search_cache putting ".
 510                 scalar(@$data)." items at key $key with timeout $cache_timeout");
 511         $cache->put_cache($key, [ $count, $data ], $cache_timeout);
 512 }
 513
 514
 515
 516
 517
 518
 519 __PACKAGE__->register_method(
 520         method  => "biblio_mrid_to_modsbatch_batch",
 521         api_name        => "open-ils.search.biblio.metarecord.mods_slim.batch.retrieve");
 522
 523 sub biblio_mrid_to_modsbatch_batch {
 524         my( $self, $client, $mrids) = @_;
 525         warn "Performing mrid_to_modsbatch_batch...";
 526         my @mods;
 527         my $method = $self->method_lookup("open-ils.search.biblio.metarecord.mods_slim.retrieve");
 528         for my $id (@$mrids) {
 529                 next unless defined $id;
 530                 my ($m) = $method->run($id);
 531                 push @mods, $m;
 532         }
 533         return \@mods;
 534 }
 535
 536
 537 __PACKAGE__->register_method(
 538         method  => "biblio_mrid_to_modsbatch",
 539         api_name        => "open-ils.search.biblio.metarecord.mods_slim.retrieve",
 540         notes           => <<"  NOTES");
 541         Returns the mvr associated with a given metarecod. If none exists,
 542         it is created.
 543         NOTES
 544
 545 __PACKAGE__->register_method(
 546         method  => "biblio_mrid_to_modsbatch",
 547         api_name        => "open-ils.search.biblio.metarecord.mods_slim.retrieve.staff",
 548         notes           => <<"  NOTES");
 549         Returns the mvr associated with a given metarecod. If none exists,
 550         it is created.
 551         NOTES
 552
 553 sub biblio_mrid_to_modsbatch {
 554         my( $self, $client, $mrid ) = @_;
 555
 556         warn "Grabbing mvr for $mrid\n";
 557
 558         my ($mr, $evt) = _grab_metarecord($mrid);
 559         return $evt unless $mr;
 560
 561         if( my $m = $self->biblio_mrid_check_mvr($client, $mr)) {
 562                 return $m;
 563         }
 564
 565         return $self->biblio_mrid_make_modsbatch( $client, $mr );
 566 }
 567
 568 # converts a metarecord to an mvr
 569 sub _mr_to_mvr {
 570         my $mr = shift;
 571         my $perl = JSON->JSON2perl($mr->mods());
 572         return Fieldmapper::metabib::virtual_record->new($perl);
 573 }
 574
 575 # checks to see if a metarecord has mods, if so returns true;
 576
 577 __PACKAGE__->register_method(
 578         method  => "biblio_mrid_check_mvr",
 579         api_name        => "open-ils.search.biblio.metarecord.mods_slim.check",
 580         notes           => <<"  NOTES");
 581         Takes a metarecord ID or a metarecord object and returns true
 582         if the metarecord already has an mvr associated with it.
 583         NOTES
 584
 585 sub biblio_mrid_check_mvr {
 586         my( $self, $client, $mrid ) = @_;
 587         my $mr;
 588
 589         my $evt;
 590         if(ref($mrid)) { $mr = $mrid; }
 591         else { ($mr, $evt) = _grab_metarecord($mrid); }
 592         return $evt if $evt;
 593
 594         warn "Checking mvr for mr " . $mr->id . "\n";
 595
 596         return _mr_to_mvr($mr) if $mr->mods();
 597         return undef;
 598 }
 599
 600 sub _grab_metarecord {
 601         my $mrid = shift;
 602         #my $e = OpenILS::Utils::Editor->new;
 603         my $e = new_editor();
 604         my $mr = $e->retrieve_metabib_metarecord($mrid) or return ( undef, $e->event );
 605         return ($mr);
 606 }
 607
 608
 609 __PACKAGE__->register_method(
 610         method  => "biblio_mrid_make_modsbatch",
 611         api_name        => "open-ils.search.biblio.metarecord.mods_slim.create",
 612         notes           => <<"  NOTES");
 613         Takes either a metarecord ID or a metarecord object.
 614         Forces the creations of an mvr for the given metarecord.
 615         The created mvr is returned.
 616         NOTES
 617
 618 sub biblio_mrid_make_modsbatch {
 619         my( $self, $client, $mrid ) = @_;
 620
 621         #my $e = OpenILS::Utils::Editor->new;
 622         my $e = new_editor();
 623
 624         my $mr;
 625         if( ref($mrid) ) {
 626                 $mr = $mrid;
 627                 $mrid = $mr->id;
 628         } else {
 629                 $mr = $e->retrieve_metabib_metarecord($mrid)
 630                         or return $e->event;
 631         }
 632
 633         my $masterid = $mr->master_record;
 634         $logger->info("creating new mods batch for metarecord=$mrid, master record=$masterid");
 635
 636         my $ids = $U->storagereq(
 637                 'open-ils.storage.ordered.metabib.metarecord.records.staff.atomic', $mrid);
 638         return undef unless @$ids;
 639
 640         my $master = $e->retrieve_biblio_record_entry($masterid)
 641                 or return $e->event;
 642
 643         # start the mods batch
 644         my $u = OpenILS::Utils::ModsParser->new();
 645         $u->start_mods_batch( $master->marc );
 646
 647         # grab all of the sub-records and shove them into the batch
 648         my @ids = grep { $_ ne $masterid } @$ids;
 649         my $subrecs = (@ids) ? $e->batch_retrieve_biblio_record_entry(\@ids) : [];
 650
 651         for(@$subrecs) {
 652                 $logger->debug("adding record ".$_->id." to mods batch for metarecord=$mrid");
 653                 $u->push_mods_batch( $_->marc ) if $_->marc;
 654         }
 655
 656
 657         # finish up and send to the client
 658         my $mods = $u->finish_mods_batch();
 659         $mods->doc_id($mrid);
 660         $client->respond_complete($mods);
 661
 662
 663         # now update the mods string in the db
 664         my $string = JSON->perl2JSON($mods->decast);
 665         $mr->mods($string);
 666
 667         #$e = OpenILS::Utils::Editor->new(xact => 1);
 668         $e = new_editor(xact => 1);
 669         $e->update_metabib_metarecord($mr)
 670                 or $logger->error("Error setting mods text on metarecord $mrid : " . Dumper($e->event));
 671         $e->finish;
 672
 673         return undef;
 674 }
 675
 676
 677
 678
 679 # converts a mr id into a list of record ids
 680
 681 __PACKAGE__->register_method(
 682         method  => "biblio_mrid_to_record_ids",
 683         api_name        => "open-ils.search.biblio.metarecord_to_records",
 684 );
 685
 686 __PACKAGE__->register_method(
 687         method  => "biblio_mrid_to_record_ids",
 688         api_name        => "open-ils.search.biblio.metarecord_to_records.staff",
 689 );
 690
 691 sub biblio_mrid_to_record_ids {
 692         my( $self, $client, $mrid, $args ) = @_;
 693
 694         my $format      = $$args{format};
 695         my $org         = $$args{org};
 696         my $depth       = $$args{depth};
 697
 698         my $method = "open-ils.storage.ordered.metabib.metarecord.records.atomic";
 699         $method =~ s/atomic/staff\.atomic/o if $self->api_name =~ /staff/o;
 700         my $recs = $U->storagereq($method, $mrid, $format, $org, $depth);
 701
 702         return { count => scalar(@$recs), ids => $recs };
 703 }
 704
 705
 706 __PACKAGE__->register_method(
 707         method  => "biblio_record_to_marc_html",
 708         api_name        => "open-ils.search.biblio.record.html" );
 709
 710 my $parser              = XML::LibXML->new();
 711 my $xslt                        = XML::LibXSLT->new();
 712 my $marc_sheet;
 713
 714 my $settings_client = OpenSRF::Utils::SettingsClient->new();
 715 sub biblio_record_to_marc_html {
 716         my( $self, $client, $recordid ) = @_;
 717
 718         if( !$marc_sheet ) {
 719                 my $dir = $settings_client->config_value( "dirs", "xsl" );
 720                 my $xsl = $settings_client->config_value(
 721                         "apps", "open-ils.search", "app_settings", "marc_html_xsl" );
 722
 723                 $xsl = $parser->parse_file("$dir/$xsl");
 724                 $marc_sheet = $xslt->parse_stylesheet( $xsl );
 725         }
 726
 727
 728         my $record = $apputils->simple_scalar_request(
 729                 "open-ils.cstore",
 730                 "open-ils.cstore.direct.biblio.record_entry.retrieve",
 731                 $recordid );
 732
 733         my $xmldoc = $parser->parse_string($record->marc);
 734         my $html = $marc_sheet->transform($xmldoc);
 735         $html = $html->toString();
 736         return $html;
 737
 738 }
 739
 740
 741 =head duplicate
 742 __PACKAGE__->register_method(
 743         method  => "retrieve_all_copy_locations",
 744         api_name        => "open-ils.search.config.copy_location.retrieve.all" );
 745
 746 my $shelving_locations;
 747 sub retrieve_all_copy_locations {
 748         my( $self, $client ) = @_;
 749         if(!$shelving_locations) {
 750                 $shelving_locations = $apputils->simple_scalar_request(
 751                         "open-ils.cstore",
 752                         "open-ils.cstore.direct.asset.copy_location.search.atomic",
 753                         { id => { "!=" => undef } }
 754                 );
 755         }
 756         return $shelving_locations;
 757 }
 758 =cut
 759
 760
 761
 762 __PACKAGE__->register_method(
 763         method  => "retrieve_all_copy_statuses",
 764         api_name        => "open-ils.search.config.copy_status.retrieve.all" );
 765
 766 my $copy_statuses;
 767 sub retrieve_all_copy_statuses {
 768         my( $self, $client ) = @_;
 769         return $copy_statuses if $copy_statuses;
 770         return $copy_statuses =
 771                 new_editor()->retrieve_all_config_copy_status();
 772 }
 773
 774
 775 __PACKAGE__->register_method(
 776         method  => "copy_counts_per_org",
 777         api_name        => "open-ils.search.biblio.copy_counts.retrieve");
 778
 779 __PACKAGE__->register_method(
 780         method  => "copy_counts_per_org",
 781         api_name        => "open-ils.search.biblio.copy_counts.retrieve.staff");
 782
 783 sub copy_counts_per_org {
 784         my( $self, $client, $record_id ) = @_;
 785
 786         warn "Retreiveing copy copy counts for record $record_id and method " . $self->api_name . "\n";
 787
 788         my $method = "open-ils.storage.biblio.record_entry.global_copy_count.atomic";
 789         if($self->api_name =~ /staff/) { $method =~ s/atomic/staff\.atomic/; }
 790
 791         my $counts = $apputils->simple_scalar_request(
 792                 "open-ils.storage", $method, $record_id );
 793
 794         $counts = [ sort {$a->[0] <=> $b->[0]} @$counts ];
 795         return $counts;
 796 }
 797
 798
 799 __PACKAGE__->register_method(
 800         method          => "copy_count_summary",
 801         api_name        => "open-ils.search.biblio.copy_counts.summary.retrieve",
 802         notes           => <<"  NOTES");
 803         returns an array of these:
 804                 [ org_id, callnumber_label, <status1_count>, <status2_cout>,...]
 805                 where statusx is a copy status name.  the statuses are sorted
 806                 by id.
 807         NOTES
 808
 809 sub copy_count_summary {
 810         my( $self, $client, $rid, $org, $depth ) = @_;
 811         $org ||= 1;
 812         $depth ||= 0;
 813         return $U->storagereq(
 814                 'open-ils.storage.biblio.record_entry.status_copy_count.atomic', $rid, $org, $depth );
 815 }
 816
 817
 818
 819 =head
 820 __PACKAGE__->register_method(
 821         method          => "multiclass_search",
 822         api_name        => "open-ils.search.biblio.multiclass",
 823         notes           => <<"  NOTES");
 824                 Performs a multiclass search
 825                 PARAMS( searchBlob, org_unit, format, limit )
 826                 where searchBlob is defined like this:
 827                         {
 828                                 "title" : { "term" : "water" },
 829                                 "author" : { "term" : "smith" },
 830                                 ...
 831                         }
 832         NOTES
 833
 834 __PACKAGE__->register_method(
 835         method          => "multiclass_search",
 836         api_name        => "open-ils.search.biblio.multiclass.staff",
 837         notes           => "see open-ils.search.biblio.multiclass" );
 838
 839 sub multiclass_search {
 840         my( $self, $client, $searchBlob, $orgid, $format, $limit ) = @_;
 841
 842         $logger->debug("Performing multiclass search with org => $orgid, " .
 843                 "format => $format, limit => $limit, and search blob " . Dumper($searchBlob));
 844
 845         my $meth = 'open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.atomic';
 846         if($self->api_name =~ /staff/) { $meth =~ s/metarecord\.atomic/metarecord.staff.atomic/; }
 847
 848
 849         my $records = $apputils->simplereq(
 850                 'open-ils.storage', $meth,
 851                  org_unit => $orgid, searches => $searchBlob, format => $format, limit => $limit );
 852
 853         my $count = 0;
 854         my $recs = [];
 855
 856         if( ref($records) and $records->[0] and
 857                 defined($records->[0]->[3])) { $count = $records->[0]->[3];}
 858
 859         for my $r (@$records) { push( @$recs, $r ) if ($r and $r->[0]); }
 860
 861         # records has the form: [ mrid, rank, singleRecord / 0, hitCount ];
 862         return { ids => $recs, count => $count };
 863 }
 864 =cut
 865
 866
 867 =head comment-1
 868 __PACKAGE__->register_method(
 869         method          => "multiclass_search",
 870         api_name                => "open-ils.search.biblio.multiclass",
 871         signature       => q/
 872                 Performs a multiclass search
 873                 @param args A names hash of arguments:
 874                         org_unit : The org to focus the search on
 875                         depth           : The search depth
 876                         format  : Item format
 877                         limit           : Return limit
 878                         offset  : Search offset
 879                         searches : A named hash of searches which has the following format:
 880                                 {
 881                                         "title" : { "term" : "water" },
 882                                         "author" : { "term" : "smith" },
 883                                         ...
 884                                 }
 885                 @return { ids : <array of ids>, count : hitcount }
 886         /
 887 );
 888
 889 __PACKAGE__->register_method(
 890         method          => "multiclass_search",
 891         api_name                => "open-ils.search.biblio.multiclass.staff",
 892         notes           => q/@see open-ils.search.biblio.multiclass/ );
 893
 894 sub multiclass_search {
 895         my( $self, $client, $args ) = @_;
 896
 897         $logger->debug("Performing multiclass search with args:\n" . Dumper($args));
 898         my $meth = 'open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.atomic';
 899         if($self->api_name =~ /staff/) { $meth =~ s/metarecord\.atomic/metarecord.staff.atomic/; }
 900
 901         my $records = $apputils->simplereq( 'open-ils.storage', $meth, %$args );
 902
 903         my $count = 0;
 904         my $recs = [];
 905
 906         if( ref($records) and $records->[0] and
 907                 defined($records->[0]->[3])) { $count = $records->[0]->[3];}
 908
 909         for my $r (@$records) { push( @$recs, $r ) if ($r and $r->[0]); }
 910
 911         return { ids => $recs, count => $count };
 912 }
 913
 914 =cut
 915
 916
 917
 918 __PACKAGE__->register_method(
 919         method          => "marc_search",
 920         api_name        => "open-ils.search.biblio.marc.staff");
 921
 922 __PACKAGE__->register_method(
 923         method          => "marc_search",
 924         api_name        => "open-ils.search.biblio.marc",
 925         notes           => <<"  NOTES");
 926                 Example:
 927                 open-ils.storage.biblio.full_rec.multi_search.atomic
 928                 { "searches": [{"term":"harry","restrict": [{"tag":245,"subfield":"a"}]}], "org_unit": 1,
 929         "limit":5,"sort":"author","item_type":"g"}
 930         NOTES
 931
 932 sub marc_search {
 933         my( $self, $conn, $args, $limit, $offset ) = @_;
 934
 935         my $method = 'open-ils.storage.biblio.full_rec.multi_search';
 936         $method .= ".staff" if $self->api_name =~ /staff/;
 937         $method .= ".atomic";
 938
 939         $limit ||= 10;
 940         $offset ||= 0;
 941
 942         my @search;
 943         push( @search, ($_ => $$args{$_}) ) for (sort keys %$args);
 944         my $ckey = $pfx . md5_hex($method . JSON->perl2JSON(\@search));
 945
 946         my $recs = search_cache($ckey, $offset, $limit);
 947
 948         if(!$recs) {
 949                 $recs = $U->storagereq($method, %$args);
 950                 put_cache($ckey, scalar(@$recs), $recs);
 951                 $recs = [ @$recs[$offset..($offset + ($limit - 1))] ];
 952         }
 953
 954         my $count = 0;
 955         $count = $recs->[0]->[2] if $recs->[0] and $recs->[0]->[2];
 956         my @recs = map { $_->[0] } @$recs;
 957
 958         return { ids => \@recs, count => $count };
 959 }
 960
 961
 962 __PACKAGE__->register_method(
 963         method  => "biblio_search_isbn",
 964         api_name        => "open-ils.search.biblio.isbn",
 965 );
 966
 967 sub biblio_search_isbn {
 968         my( $self, $client, $isbn ) = @_;
 969         $logger->debug("Searching ISBN $isbn");
 970         my $e = new_editor();
 971         my $recs = $U->storagereq(
 972                 'open-ils.storage.id_list.biblio.record_entry.search.isbn.atomic', $isbn );
 973         return { ids => $recs, count => scalar(@$recs) };
 974 }
 975
 976
 977 __PACKAGE__->register_method(
 978         method  => "biblio_search_issn",
 979         api_name        => "open-ils.search.biblio.issn",
 980 );
 981
 982 sub biblio_search_issn {
 983         my( $self, $client, $issn ) = @_;
 984         $logger->debug("Searching ISSN $issn");
 985         my $e = new_editor();
 986         my $recs = $U->storagereq(
 987                 'open-ils.storage.id_list.biblio.record_entry.search.issn.atomic', $issn );
 988         return { ids => $recs, count => scalar(@$recs) };
 989 }
 990
 991
 992
 993
 994 __PACKAGE__->register_method(
 995         method  => "fetch_mods_by_copy",
 996         api_name        => "open-ils.search.biblio.mods_from_copy",
 997 );
 998
 999 sub fetch_mods_by_copy {
1000         my( $self, $client, $copyid ) = @_;
1001         my ($record, $evt) = $apputils->fetch_record_by_copy( $copyid );
1002         return $evt if $evt;
1003         return OpenILS::Event->new('ITEM_NOT_CATALOGED') unless $record->marc;
1004         return $apputils->record_to_mvr($record);
1005 }
1006
1007
1008
1009 # -------------------------------------------------------------------------------------
1010
1011 __PACKAGE__->register_method(
1012         method  => "cn_browse",
1013         api_name        => "open-ils.search.callnumber.browse.target",
1014         notes           => "Starts a callnumber browse"
1015         );
1016
1017 __PACKAGE__->register_method(
1018         method  => "cn_browse",
1019         api_name        => "open-ils.search.callnumber.browse.page_up",
1020         notes           => "Returns the previous page of callnumbers",
1021         );
1022
1023 __PACKAGE__->register_method(
1024         method  => "cn_browse",
1025         api_name        => "open-ils.search.callnumber.browse.page_down",
1026         notes           => "Returns the next page of callnumbers",
1027         );
1028
1029
1030 # RETURNS array of arrays like so: label, owning_lib, record, id
1031 sub cn_browse {
1032         my( $self, $client, @params ) = @_;
1033         my $method;
1034
1035         $method = 'open-ils.storage.asset.call_number.browse.target.atomic'
1036                 if( $self->api_name =~ /target/ );
1037         $method = 'open-ils.storage.asset.call_number.browse.page_up.atomic'
1038                 if( $self->api_name =~ /page_up/ );
1039         $method = 'open-ils.storage.asset.call_number.browse.page_down.atomic'
1040                 if( $self->api_name =~ /page_down/ );
1041
1042         return $apputils->simplereq( 'open-ils.storage', $method, @params );
1043 }
1044 # -------------------------------------------------------------------------------------
1045
1046 __PACKAGE__->register_method(
1047         method => "fetch_cn",
1048         api_name => "open-ils.search.callnumber.retrieve",
1049         notes           => "retrieves a callnumber based on ID",
1050         );
1051
1052 sub fetch_cn {
1053         my( $self, $client, $id ) = @_;
1054         my( $cn, $evt ) = $apputils->fetch_callnumber( $id );
1055         return $evt if $evt;
1056         return $cn;
1057 }
1058
1059 __PACKAGE__->register_method (
1060         method          => "fetch_copy_by_cn",
1061         api_name                => 'open-ils.search.copies_by_call_number.retrieve',
1062         signature       => q/
1063                 Returns an array of copy id's by callnumber id
1064                 @param cnid The callnumber id
1065                 @return An array of copy ids
1066         /
1067 );
1068
1069 sub fetch_copy_by_cn {
1070         my( $self, $conn, $cnid ) = @_;
1071         return $U->cstorereq(
1072                 'open-ils.cstore.direct.asset.copy.id_list.atomic',
1073                 { call_number => $cnid, deleted => 'f' } );
1074 }
1075
1076 __PACKAGE__->register_method (
1077         method          => 'fetch_cn_by_info',
1078         api_name                => 'open-ils.search.call_number.retrieve_by_info',
1079         signature       => q/
1080                 @param label The callnumber label
1081                 @param record The record the cn is attached to
1082                 @param org The owning library of the cn
1083                 @return The callnumber object
1084         /
1085 );
1086
1087
1088 sub fetch_cn_by_info {
1089         my( $self, $conn, $label, $record, $org ) = @_;
1090         return $U->cstorereq(
1091                 'open-ils.cstore.direct.asset.call_number.search',
1092                 { label => $label, record => $record, owning_lib => $org, deleted => 'f' });
1093 }
1094
1095
1096
1097
1098
1099 __PACKAGE__->register_method (
1100         method => 'bib_extras',
1101         api_name => 'open-ils.search.biblio.lit_form_map.retrieve.all');
1102 __PACKAGE__->register_method (
1103         method => 'bib_extras',
1104         api_name => 'open-ils.search.biblio.item_form_map.retrieve.all');
1105 __PACKAGE__->register_method (
1106         method => 'bib_extras',
1107         api_name => 'open-ils.search.biblio.item_type_map.retrieve.all');
1108 __PACKAGE__->register_method (
1109         method => 'bib_extras',
1110         api_name => 'open-ils.search.biblio.audience_map.retrieve.all');
1111
1112 sub bib_extras {
1113         my $self = shift;
1114
1115         my $e = new_editor();
1116
1117         return $e->retrieve_all_config_lit_form_map()
1118                 if( $self->api_name =~ /lit_form/ );
1119
1120         return $e->retrieve_all_config_item_form_map()
1121                 if( $self->api_name =~ /item_form_map/ );
1122
1123         return $e->retrieve_all_config_item_type_map()
1124                 if( $self->api_name =~ /item_type_map/ );
1125
1126         return $e->retrieve_all_config_audience_map()
1127                 if( $self->api_name =~ /audience_map/ );
1128
1129         return [];
1130 }
1131
1132
1133
1134 __PACKAGE__->register_method(
1135         method  => 'fetch_slim_record',
1136         api_name        => 'open-ils.search.biblio.record_entry.slim.retrieve',
1137         signature=> q/
1138                 Returns a biblio.record_entry without the attached marcxml
1139         /
1140 );
1141
1142 sub fetch_slim_record {
1143         my( $self, $conn, $ids ) = @_;
1144
1145         #my $editor = OpenILS::Utils::Editor->new;
1146         my $editor = new_editor();
1147         my @res;
1148         for( @$ids ) {
1149                 return $editor->event unless
1150                         my $r = $editor->retrieve_biblio_record_entry($_);
1151                 $r->clear_marc;
1152                 push(@res, $r);
1153         }
1154         return \@res;
1155 }
1156
1157
1158
1159 __PACKAGE__->register_method(
1160         method => 'rec_to_mr_rec_descriptors',
1161         api_name        => 'open-ils.search.metabib.record_to_descriptors',
1162         signature       => q/
1163                 specialized method...
1164                 Given a biblio record id or a metarecord id,
1165                 this returns a list of metabib.record_descriptor
1166                 objects that live within the same metarecord
1167                 @param args Object of args including:
1168         /
1169 );
1170
1171 sub rec_to_mr_rec_descriptors {
1172         my( $self, $conn, $args ) = @_;
1173
1174         my $rec = $$args{record};
1175         my $mrec        = $$args{metarecord};
1176         my $item_forms = $$args{item_forms};
1177         my $item_types  = $$args{item_types};
1178         my $item_lang   = $$args{item_lang};
1179
1180         my $e = new_editor();
1181         my $recs;
1182
1183         if( !$mrec ) {
1184                 my $map = $e->search_metabib_metarecord_source_map({source => $rec});
1185                 return $e->event unless @$map;
1186                 $mrec = $$map[0]->metarecord;
1187         }
1188
1189         $recs = $e->search_metabib_metarecord_source_map({metarecord => $mrec});
1190         return $e->event unless @$recs;
1191
1192         my @recs = map { $_->source } @$recs;
1193         my $search = { record => \@recs };
1194         $search->{item_form} = $item_forms if $item_forms and @$item_forms;
1195         $search->{item_type} = $item_types if $item_types and @$item_types;
1196         $search->{item_lang} = $item_lang if $item_lang;
1197
1198         my $desc = $e->search_metabib_record_descriptor($search);
1199
1200         return { metarecord => $mrec, descriptors => $desc };
1201 }
1202
1203
1204
1205
1206 __PACKAGE__->register_method(
1207         method => 'copies_created_on',
1208 );
1209
1210
1211 sub copies_created_on {
1212         my( $self, $conn, $auth, $org, $date ) = @_;
1213         my $e = new_editor(authtoken=>$auth);
1214         return $e->event unless $e->checkauth;
1215 }
1216
1217
1218 __PACKAGE__->register_method(
1219         method => 'fetch_age_protect',
1220         api_name => 'open-ils.search.copy.age_protect.retrieve.all',
1221 );
1222
1223 sub fetch_age_protect {
1224         return new_editor()->retrieve_all_config_rule_age_hold_protect();
1225 }
1226
1227
1228
1229 1;
1230
1231