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

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