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