Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm

   1 # ---------------------------------------------------------------
   2 # Copyright (C) 2005  Georgia Public Library Service
   3 # Bill Erickson <highfalutin@gmail.com>
   4
   5 # This program is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU General Public License
   7 # as published by the Free Software Foundation; either version 2
   8 # of the License, or (at your option) any later version.
   9
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 # ---------------------------------------------------------------
  15
  16
  17 package OpenILS::Application::Circ::Holds;
  18 use base qw/OpenILS::Application/;
  19 use strict; use warnings;
  20 use OpenILS::Application::AppUtils;
  21 use DateTime;
  22 use Data::Dumper;
  23 use OpenSRF::EX qw(:try);
  24 use OpenILS::Perm;
  25 use OpenILS::Event;
  26 use OpenSRF::Utils;
  27 use OpenSRF::Utils::Logger qw(:logger);
  28 use OpenILS::Utils::CStoreEditor q/:funcs/;
  29 use OpenILS::Utils::PermitHold;
  30 use OpenSRF::Utils::SettingsClient;
  31 use OpenILS::Const qw/:const/;
  32 use OpenILS::Application::Circ::Transit;
  33 use OpenILS::Application::Actor::Friends;
  34 use DateTime;
  35 use DateTime::Format::ISO8601;
  36 use OpenSRF::Utils qw/:datetime/;
  37 my $apputils = "OpenILS::Application::AppUtils";
  38 my $U = $apputils;
  39
  40
  41
  42
  43 __PACKAGE__->register_method(
  44         method  => "create_hold",
  45         api_name        => "open-ils.circ.holds.create",
  46         notes           => <<NOTE);
  47 Create a new hold for an item.  From a permissions perspective,
  48 the login session is used as the 'requestor' of the hold.
  49 The hold recipient is determined by the 'usr' setting within
  50 the hold object.
  51
  52 First we verify the requestion has holds request permissions.
  53 Then we verify that the recipient is allowed to make the given hold.
  54 If not, we see if the requestor has "override" capabilities.  If not,
  55 a permission exception is returned.  If permissions allow, we cycle
  56 through the set of holds objects and create.
  57
  58 If the recipient does not have permission to place multiple holds
  59 on a single title and said operation is attempted, a permission
  60 exception is returned
  61 NOTE
  62
  63
  64 __PACKAGE__->register_method(
  65         method  => "create_hold",
  66         api_name        => "open-ils.circ.holds.create.override",
  67         signature       => q/
  68                 If the recipient is not allowed to receive the requested hold,
  69                 call this method to attempt the override
  70                 @see open-ils.circ.holds.create
  71         /
  72 );
  73
  74 sub create_hold {
  75         my( $self, $conn, $auth, $hold ) = @_;
  76         my $e = new_editor(authtoken=>$auth, xact=>1);
  77         return $e->event unless $e->checkauth;
  78
  79     return -1 unless $hold;
  80         my $override = 1 if $self->api_name =~ /override/;
  81
  82     my @events;
  83
  84     my $requestor = $e->requestor;
  85     my $recipient = $requestor;
  86
  87     if( $requestor->id ne $hold->usr ) {
  88         # Make sure the requestor is allowed to place holds for
  89         # the recipient if they are not the same people
  90         $recipient = $e->retrieve_actor_user($hold->usr) or return $e->event;
  91         $e->allowed('REQUEST_HOLDS', $recipient->home_ou) or return $e->event;
  92     }
  93
  94     # Now make sure the recipient is allowed to receive the specified hold
  95     my $pevt;
  96     my $porg = $recipient->home_ou;
  97     my $rid = $e->requestor->id;
  98     my $t = $hold->hold_type;
  99
 100     # See if a duplicate hold already exists
 101     my $sargs = {
 102         usr                     => $recipient->id,
 103         hold_type       => $t,
 104         fulfillment_time => undef,
 105         target          => $hold->target,
 106         cancel_time     => undef,
 107     };
 108
 109     $sargs->{holdable_formats} = $hold->holdable_formats if $t eq 'M';
 110
 111     my $existing = $e->search_action_hold_request($sargs);
 112     push( @events, OpenILS::Event->new('HOLD_EXISTS')) if @$existing;
 113
 114     if( $t eq OILS_HOLD_TYPE_METARECORD )
 115         { $pevt = $e->event unless $e->allowed('MR_HOLDS', $porg); }
 116
 117     if( $t eq OILS_HOLD_TYPE_TITLE )
 118         { $pevt = $e->event unless $e->allowed('TITLE_HOLDS', $porg);  }
 119
 120     if( $t eq OILS_HOLD_TYPE_VOLUME )
 121         { $pevt = $e->event unless $e->allowed('VOLUME_HOLDS', $porg); }
 122
 123     if( $t eq OILS_HOLD_TYPE_COPY )
 124         { $pevt = $e->event unless $e->allowed('COPY_HOLDS', $porg); }
 125
 126     return $pevt if $pevt;
 127
 128     if( @events ) {
 129         if( $override ) {
 130             for my $evt (@events) {
 131                 next unless $evt;
 132                 my $name = $evt->{textcode};
 133                 return $e->event unless $e->allowed("$name.override", $porg);
 134             }
 135         } else {
 136             return \@events;
 137         }
 138     }
 139
 140     # set the configured expire time
 141     unless($hold->expire_time) {
 142         my $interval = $U->ou_ancestor_setting_value($recipient->home_ou, OILS_SETTING_HOLD_EXPIRE);
 143         if($interval) {
 144             my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
 145             $hold->expire_time($U->epoch2ISO8601($date->epoch));
 146         }
 147     }
 148
 149     $hold->requestor($e->requestor->id);
 150     $hold->request_lib($e->requestor->ws_ou);
 151     $hold->selection_ou($hold->pickup_lib) unless $hold->selection_ou;
 152     $hold = $e->create_action_hold_request($hold) or return $e->event;
 153
 154         $e->commit;
 155
 156         $conn->respond_complete($hold->id);
 157
 158     $U->storagereq(
 159         'open-ils.storage.action.hold_request.copy_targeter',
 160         undef, $hold->id ) unless $U->is_true($hold->frozen);
 161
 162         return undef;
 163 }
 164
 165 sub __create_hold {
 166         my( $self, $client, $login_session, @holds) = @_;
 167
 168         if(!@holds){return 0;}
 169         my( $user, $evt ) = $apputils->checkses($login_session);
 170         return $evt if $evt;
 171
 172         my $holds;
 173         if(ref($holds[0]) eq 'ARRAY') {
 174                 $holds = $holds[0];
 175         } else { $holds = [ @holds ]; }
 176
 177         $logger->debug("Iterating over holds requests...");
 178
 179         for my $hold (@$holds) {
 180
 181                 if(!$hold){next};
 182                 my $type = $hold->hold_type;
 183
 184                 $logger->activity("User " . $user->id .
 185                         " creating new hold of type $type for user " . $hold->usr);
 186
 187                 my $recipient;
 188                 if($user->id ne $hold->usr) {
 189                         ( $recipient, $evt ) = $apputils->fetch_user($hold->usr);
 190                         return $evt if $evt;
 191
 192                 } else {
 193                         $recipient = $user;
 194                 }
 195
 196
 197                 my $perm = undef;
 198
 199                 # am I allowed to place holds for this user?
 200                 if($hold->requestor ne $hold->usr) {
 201                         $perm = _check_request_holds_perm($user->id, $user->home_ou);
 202                         if($perm) { return $perm; }
 203                 }
 204
 205                 # is this user allowed to have holds of this type?
 206                 $perm = _check_holds_perm($type, $hold->requestor, $recipient->home_ou);
 207         return $perm if $perm;
 208
 209                 #enforce the fact that the login is the one requesting the hold
 210                 $hold->requestor($user->id);
 211                 $hold->selection_ou($recipient->home_ou) unless $hold->selection_ou;
 212
 213                 my $resp = $apputils->simplereq(
 214                         'open-ils.storage',
 215                         'open-ils.storage.direct.action.hold_request.create', $hold );
 216
 217                 if(!$resp) {
 218                         return OpenSRF::EX::ERROR ("Error creating hold");
 219                 }
 220         }
 221
 222         return 1;
 223 }
 224
 225 # makes sure that a user has permission to place the type of requested hold
 226 # returns the Perm exception if not allowed, returns undef if all is well
 227 sub _check_holds_perm {
 228         my($type, $user_id, $org_id) = @_;
 229
 230         my $evt;
 231         if($type eq "M") {
 232                 if($evt = $apputils->check_perms(
 233                         $user_id, $org_id, "MR_HOLDS")) {
 234                         return $evt;
 235                 }
 236
 237         } elsif ($type eq "T") {
 238                 if($evt = $apputils->check_perms(
 239                         $user_id, $org_id, "TITLE_HOLDS")) {
 240                         return $evt;
 241                 }
 242
 243         } elsif($type eq "V") {
 244                 if($evt = $apputils->check_perms(
 245                         $user_id, $org_id, "VOLUME_HOLDS")) {
 246                         return $evt;
 247                 }
 248
 249         } elsif($type eq "C") {
 250                 if($evt = $apputils->check_perms(
 251                         $user_id, $org_id, "COPY_HOLDS")) {
 252                         return $evt;
 253                 }
 254         }
 255
 256         return undef;
 257 }
 258
 259 # tests if the given user is allowed to place holds on another's behalf
 260 sub _check_request_holds_perm {
 261         my $user_id = shift;
 262         my $org_id = shift;
 263         if(my $evt = $apputils->check_perms(
 264                 $user_id, $org_id, "REQUEST_HOLDS")) {
 265                 return $evt;
 266         }
 267 }
 268
 269 __PACKAGE__->register_method(
 270         method  => "retrieve_holds_by_id",
 271         api_name        => "open-ils.circ.holds.retrieve_by_id",
 272         notes           => <<NOTE);
 273 Retrieve the hold, with hold transits attached, for the specified id The login session is the requestor and if the requestor is
 274 different from the user, then the requestor must have VIEW_HOLD permissions.
 275 NOTE
 276
 277
 278 sub retrieve_holds_by_id {
 279         my($self, $client, $auth, $hold_id) = @_;
 280         my $e = new_editor(authtoken=>$auth);
 281         $e->checkauth or return $e->event;
 282         $e->allowed('VIEW_HOLD') or return $e->event;
 283
 284         my $holds = $e->search_action_hold_request(
 285                 [
 286                         { id =>  $hold_id , fulfillment_time => undef },
 287                         {
 288                 order_by => { ahr => "request_time" },
 289                 flesh => 1,
 290                 flesh_fields => {ahr => ['notes']}
 291             }
 292                 ]
 293         );
 294
 295         flesh_hold_transits($holds);
 296         flesh_hold_notices($holds, $e);
 297         return $holds;
 298 }
 299
 300
 301 __PACKAGE__->register_method(
 302         method  => "retrieve_holds",
 303         api_name        => "open-ils.circ.holds.retrieve",
 304         notes           => <<NOTE);
 305 Retrieves all the holds, with hold transits attached, for the specified
 306 user id.  The login session is the requestor and if the requestor is
 307 different from the user, then the requestor must have VIEW_HOLD permissions.
 308 NOTE
 309
 310 __PACKAGE__->register_method(
 311         method  => "retrieve_holds",
 312     authoritative => 1,
 313         api_name        => "open-ils.circ.holds.id_list.retrieve",
 314         notes           => <<NOTE);
 315 Retrieves all the hold ids for the specified
 316 user id.  The login session is the requestor and if the requestor is
 317 different from the user, then the requestor must have VIEW_HOLD permissions.
 318 NOTE
 319
 320
 321 __PACKAGE__->register_method(
 322         method  => "retrieve_holds",
 323     authoritative => 1,
 324         api_name        => "open-ils.circ.holds.canceled.retrieve",
 325 );
 326
 327 __PACKAGE__->register_method(
 328         method  => "retrieve_holds",
 329     authoritative => 1,
 330         api_name        => "open-ils.circ.holds.canceled.id_list.retrieve",
 331 );
 332
 333
 334 sub retrieve_holds {
 335         my($self, $client, $auth, $user_id, $options) = @_;
 336
 337     my $e = new_editor(authtoken=>$auth);
 338     return $e->event unless $e->checkauth;
 339     $user_id = $e->requestor->id unless defined $user_id;
 340     $options ||= {};
 341
 342     unless($user_id == $e->requestor->id) {
 343         my $user = $e->retrieve_actor_user($user_id) or return $e->event;
 344         unless($e->allowed('VIEW_HOLD', $user->home_ou)) {
 345             my $allowed = OpenILS::Application::Actor::Friends->friend_perm_allowed(
 346                 $e, $user_id, $e->requestor->id, 'hold.view');
 347             return $e->event unless $allowed;
 348         }
 349     }
 350
 351     my $holds;
 352
 353     if($self->api_name !~ /canceled/) {
 354
 355         # Fetch the active holds
 356
 357         $holds = $e->search_action_hold_request([
 358             {   usr =>  $user_id ,
 359                 fulfillment_time => undef,
 360                 cancel_time => undef,
 361             },
 362             {order_by => {ahr => "request_time"}}
 363         ]);
 364
 365     } else {
 366
 367         # Fetch the canceled holds
 368
 369         my $cancel_age;
 370         my $cancel_count =
 371             $U->ou_ancestor_setting_value(
 372                 $e->requestor->ws_ou, 'circ.holds.canceled.display_count', $e);
 373
 374         unless($cancel_count) {
 375             $cancel_age = $U->ou_ancestor_setting_value(
 376                 $e->requestor->ws_ou, 'circ.holds.canceled.display_age', $e);
 377         }
 378
 379         if($cancel_count) { # limit by count
 380
 381             # find at most cancel_count canceled holds
 382             $holds = $e->search_action_hold_request([
 383                 {   usr =>  $user_id ,
 384                     fulfillment_time => undef,
 385                     cancel_time => {'!=' => undef},
 386                 },
 387                 {order_by => {ahr => "cancel_time desc"}, limit => $cancel_count}
 388             ]);
 389
 390         } elsif($cancel_age) { # limit by age
 391
 392             # find all of the canceled holds that were canceled within the configured time frame
 393             my $date = DateTime->now->subtract(seconds => OpenSRF::Utils::interval_to_seconds($cancel_age));
 394             $date = $U->epoch2ISO8601($date->epoch);
 395
 396             $holds = $e->search_action_hold_request([
 397                 {   usr =>  $user_id ,
 398                     fulfillment_time => undef,
 399                     cancel_time => {'>=' => $date},
 400                 },
 401                 {order_by => {ahr => "cancel_time desc"}}
 402             ]);
 403         }
 404     }
 405
 406         if( ! $self->api_name =~ /id_list/ ) {
 407                 for my $hold ( @$holds ) {
 408                         $hold->transit(
 409                 $e->search_action_hold_transit_copy([
 410                                         {hold => $hold->id},
 411                                         {order_by => {ahtc => 'id desc'}, limit => 1}])->[0]
 412                         );
 413                 }
 414         }
 415
 416         if( $self->api_name =~ /id_list/ ) {
 417                 return [ map { $_->id } @$holds ];
 418         } else {
 419                 return $holds;
 420         }
 421 }
 422
 423
 424 __PACKAGE__->register_method(
 425    method => 'user_hold_count',
 426    api_name => 'open-ils.circ.hold.user.count');
 427
 428 sub user_hold_count {
 429    my( $self, $conn, $auth, $userid ) = @_;
 430    my $e = new_editor(authtoken=>$auth);
 431    return $e->event unless $e->checkauth;
 432    my $patron = $e->retrieve_actor_user($userid)
 433       or return $e->event;
 434    return $e->event unless $e->allowed('VIEW_HOLD', $patron->home_ou);
 435    return __user_hold_count($self, $e, $userid);
 436 }
 437
 438 sub __user_hold_count {
 439    my( $self, $e, $userid ) = @_;
 440    my $holds = $e->search_action_hold_request(
 441       {  usr =>  $userid ,
 442          fulfillment_time => undef,
 443          cancel_time => undef,
 444       },
 445       {idlist => 1}
 446    );
 447
 448    return scalar(@$holds);
 449 }
 450
 451
 452 __PACKAGE__->register_method(
 453         method  => "retrieve_holds_by_pickup_lib",
 454         api_name        => "open-ils.circ.holds.retrieve_by_pickup_lib",
 455         notes           => <<NOTE);
 456 Retrieves all the holds, with hold transits attached, for the specified
 457 pickup_ou id.
 458 NOTE
 459
 460 __PACKAGE__->register_method(
 461         method  => "retrieve_holds_by_pickup_lib",
 462         api_name        => "open-ils.circ.holds.id_list.retrieve_by_pickup_lib",
 463         notes           => <<NOTE);
 464 Retrieves all the hold ids for the specified
 465 pickup_ou id.
 466 NOTE
 467
 468 sub retrieve_holds_by_pickup_lib {
 469         my($self, $client, $login_session, $ou_id) = @_;
 470
 471         #FIXME -- put an appropriate permission check here
 472         #my( $user, $target, $evt ) = $apputils->checkses_requestor(
 473         #       $login_session, $user_id, 'VIEW_HOLD' );
 474         #return $evt if $evt;
 475
 476         my $holds = $apputils->simplereq(
 477                 'open-ils.cstore',
 478                 "open-ils.cstore.direct.action.hold_request.search.atomic",
 479                 {
 480                         pickup_lib =>  $ou_id ,
 481                         fulfillment_time => undef,
 482                         cancel_time => undef
 483                 },
 484                 { order_by => { ahr => "request_time" } });
 485
 486
 487         if( ! $self->api_name =~ /id_list/ ) {
 488                 flesh_hold_transits($holds);
 489         }
 490
 491         if( $self->api_name =~ /id_list/ ) {
 492                 return [ map { $_->id } @$holds ];
 493         } else {
 494                 return $holds;
 495         }
 496 }
 497
 498
 499 __PACKAGE__->register_method(
 500         method  => "uncancel_hold",
 501         api_name        => "open-ils.circ.hold.uncancel"
 502 );
 503
 504 sub uncancel_hold {
 505         my($self, $client, $auth, $hold_id) = @_;
 506         my $e = new_editor(authtoken=>$auth, xact=>1);
 507         return $e->event unless $e->checkauth;
 508
 509         my $hold = $e->retrieve_action_hold_request($hold_id)
 510                 or return $e->die_event;
 511     return $e->die_event unless $e->allowed('CANCEL_HOLDS', $hold->request_lib);
 512
 513     return 0 if $hold->fulfillment_time;
 514     return 1 unless $hold->cancel_time;
 515
 516     # if configured to reset the request time, also reset the expire time
 517     if($U->ou_ancestor_setting_value(
 518         $hold->request_lib, 'circ.holds.uncancel.reset_request_time', $e)) {
 519
 520         $hold->request_time('now');
 521         my $interval = $U->ou_ancestor_setting_value($hold->request_lib, OILS_SETTING_HOLD_EXPIRE);
 522         if($interval) {
 523             my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
 524             $hold->expire_time($U->epoch2ISO8601($date->epoch));
 525         }
 526     }
 527
 528     $hold->clear_cancel_time;
 529     $hold->clear_cancel_cause;
 530     $hold->clear_cancel_note;
 531     $e->update_action_hold_request($hold) or return $e->die_event;
 532     $e->commit;
 533
 534     $U->storagereq('open-ils.storage.action.hold_request.copy_targeter', undef, $hold_id);
 535
 536     return 1;
 537 }
 538
 539
 540 __PACKAGE__->register_method(
 541         method  => "cancel_hold",
 542         api_name        => "open-ils.circ.hold.cancel",
 543         notes           => <<"  NOTE");
 544         Cancels the specified hold.  The login session
 545         is the requestor and if the requestor is different from the usr field
 546         on the hold, the requestor must have CANCEL_HOLDS permissions.
 547         the hold may be either the hold object or the hold id
 548         NOTE
 549
 550 sub cancel_hold {
 551         my($self, $client, $auth, $holdid, $cause, $note) = @_;
 552
 553         my $e = new_editor(authtoken=>$auth, xact=>1);
 554         return $e->event unless $e->checkauth;
 555
 556         my $hold = $e->retrieve_action_hold_request($holdid)
 557                 or return $e->event;
 558
 559         if( $e->requestor->id ne $hold->usr ) {
 560                 return $e->event unless $e->allowed('CANCEL_HOLDS');
 561         }
 562
 563         return 1 if $hold->cancel_time;
 564
 565         # If the hold is captured, reset the copy status
 566         if( $hold->capture_time and $hold->current_copy ) {
 567
 568                 my $copy = $e->retrieve_asset_copy($hold->current_copy)
 569                         or return $e->event;
 570
 571                 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
 572          $logger->info("canceling hold $holdid whose item is on the holds shelf");
 573 #                       $logger->info("setting copy to status 'reshelving' on hold cancel");
 574 #                       $copy->status(OILS_COPY_STATUS_RESHELVING);
 575 #                       $copy->editor($e->requestor->id);
 576 #                       $copy->edit_date('now');
 577 #                       $e->update_asset_copy($copy) or return $e->event;
 578
 579                 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
 580
 581                         my $hid = $hold->id;
 582                         $logger->warn("! canceling hold [$hid] that is in transit");
 583                         my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
 584
 585                         if( $transid ) {
 586                                 my $trans = $e->retrieve_action_transit_copy($transid);
 587                                 # Leave the transit alive, but  set the copy status to
 588                                 # reshelving so it will be properly reshelved when it gets back home
 589                                 if( $trans ) {
 590                                         $trans->copy_status( OILS_COPY_STATUS_RESHELVING );
 591                                         $e->update_action_transit_copy($trans) or return $e->die_event;
 592                                 }
 593                         }
 594                 }
 595         }
 596
 597         $hold->cancel_time('now');
 598     $hold->cancel_cause($cause);
 599     $hold->cancel_note($note);
 600         $e->update_action_hold_request($hold)
 601                 or return $e->event;
 602
 603         delete_hold_copy_maps($self, $e, $hold->id);
 604
 605         $e->commit;
 606         return 1;
 607 }
 608
 609 sub delete_hold_copy_maps {
 610         my $class = shift;
 611         my $editor = shift;
 612         my $holdid = shift;
 613
 614         my $maps = $editor->search_action_hold_copy_map({hold=>$holdid});
 615         for(@$maps) {
 616                 $editor->delete_action_hold_copy_map($_)
 617                         or return $editor->event;
 618         }
 619         return undef;
 620 }
 621
 622
 623 __PACKAGE__->register_method(
 624         method  => "update_hold",
 625         api_name        => "open-ils.circ.hold.update",
 626         notes           => <<"  NOTE");
 627         Updates the specified hold.  The login session
 628         is the requestor and if the requestor is different from the usr field
 629         on the hold, the requestor must have UPDATE_HOLDS permissions.
 630         NOTE
 631
 632 __PACKAGE__->register_method(
 633         method  => "batch_update_hold",
 634         api_name        => "open-ils.circ.hold.update.batch",
 635     stream => 1,
 636         notes           => <<"  NOTE");
 637         Updates the specified hold.  The login session
 638         is the requestor and if the requestor is different from the usr field
 639         on the hold, the requestor must have UPDATE_HOLDS permissions.
 640         NOTE
 641
 642 sub update_hold {
 643         my($self, $client, $auth, $hold, $values) = @_;
 644     my $e = new_editor(authtoken=>$auth, xact=>1);
 645     return $e->die_event unless $e->checkauth;
 646     my $resp = update_hold_impl($self, $e, $hold, $values);
 647     return $resp if $U->event_code($resp);
 648     $e->commit;
 649     return $resp;
 650 }
 651
 652 sub batch_update_hold {
 653         my($self, $client, $auth, $hold_list, $values_list) = @_;
 654     my $e = new_editor(authtoken=>$auth);
 655     return $e->die_event unless $e->checkauth;
 656
 657     my $count = ($hold_list) ? scalar(@$hold_list) : scalar(@$values_list);
 658     $hold_list ||= [];
 659     $values_list ||= [];
 660
 661     for my $idx (0..$count-1) {
 662         $e->xact_begin;
 663         my $resp = update_hold_impl($self, $e, $hold_list->[$idx], $values_list->[$idx]);
 664         $e->xact_commit unless $U->event_code($resp);
 665         $client->respond($resp);
 666     }
 667
 668     $e->disconnect;
 669     return undef;
 670 }
 671
 672 sub update_hold_impl {
 673     my($self, $e, $hold, $values) = @_;
 674
 675     unless($hold) {
 676         $hold = $e->retrieve_action_hold_request($values->{id})
 677             or return $e->die_event;
 678         $hold->$_($values->{$_}) for keys %$values;
 679     }
 680
 681     my $orig_hold = $e->retrieve_action_hold_request($hold->id)
 682         or return $e->die_event;
 683
 684     # don't allow the user to be changed
 685     return OpenILS::Event->new('BAD_PARAMS') if $hold->usr != $orig_hold->usr;
 686
 687     if($hold->usr ne $e->requestor->id) {
 688         # if the hold is for a different user, make sure the
 689         # requestor has the appropriate permissions
 690         my $usr = $e->retrieve_actor_user($hold->usr)
 691             or return $e->die_event;
 692         return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
 693     }
 694
 695
 696     # --------------------------------------------------------------
 697     # if the hold is on the holds shelf or in transit and the pickup
 698     # lib changes we need to create a new transit.
 699     # --------------------------------------------------------------
 700     if($orig_hold->pickup_lib ne $hold->pickup_lib) {
 701
 702         my $status = _hold_status($e, $hold);
 703
 704         if($status == 3) { # in transit
 705
 706             return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $orig_hold->pickup_lib);
 707             return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $hold->pickup_lib);
 708
 709             $logger->info("updating pickup lib for hold ".$hold->id." while already in transit");
 710
 711             # update the transit to reflect the new pickup location
 712                         my $transit = $e->search_action_hold_transit_copy(
 713                 {hold=>$hold->id, dest_recv_time => undef})->[0]
 714                 or return $e->die_event;
 715
 716             $transit->dest($hold->pickup_lib);
 717             $e->update_action_hold_transit_copy($transit) or return $e->die_event;
 718
 719         } elsif($status == 4) { # on holds shelf
 720
 721             return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $orig_hold->pickup_lib);
 722             return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $hold->pickup_lib);
 723
 724             $logger->info("updating pickup lib for hold ".$hold->id." while on holds shelf");
 725
 726             # create the new transit
 727             my $evt = transit_hold($e, $orig_hold, $hold, $e->retrieve_asset_copy($hold->current_copy));
 728             return $evt if $evt;
 729         }
 730     }
 731
 732     update_hold_if_frozen($self, $e, $hold, $orig_hold);
 733     $e->update_action_hold_request($hold) or return $e->die_event;
 734     $e->commit;
 735     return $hold->id;
 736 }
 737
 738 sub transit_hold {
 739     my($e, $orig_hold, $hold, $copy) = @_;
 740     my $src = $orig_hold->pickup_lib;
 741     my $dest = $hold->pickup_lib;
 742
 743     $logger->info("putting hold into transit on pickup_lib update");
 744
 745     my $transit = Fieldmapper::action::hold_transit_copy->new;
 746     $transit->hold($hold->id);
 747     $transit->source($src);
 748     $transit->dest($dest);
 749     $transit->target_copy($copy->id);
 750     $transit->source_send_time('now');
 751     $transit->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
 752
 753     $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
 754     $copy->editor($e->requestor->id);
 755     $copy->edit_date('now');
 756
 757     $e->create_action_hold_transit_copy($transit) or return $e->die_event;
 758     $e->update_asset_copy($copy) or return $e->die_event;
 759     return undef;
 760 }
 761
 762 # if the hold is frozen, this method ensures that the hold is not "targeted",
 763 # that is, it clears the current_copy and prev_check_time to essentiallly
 764 # reset the hold.  If it is being activated, it runs the targeter in the background
 765 sub update_hold_if_frozen {
 766     my($self, $e, $hold, $orig_hold) = @_;
 767     return if $hold->capture_time;
 768
 769     if($U->is_true($hold->frozen)) {
 770         $logger->info("clearing current_copy and check_time for frozen hold ".$hold->id);
 771         $hold->clear_current_copy;
 772         $hold->clear_prev_check_time;
 773
 774     } else {
 775         if($U->is_true($orig_hold->frozen)) {
 776             $logger->info("Running targeter on activated hold ".$hold->id);
 777                 $U->storagereq( 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
 778         }
 779     }
 780 }
 781 __PACKAGE__->register_method(
 782         method  => "hold_note_CUD",
 783         api_name        => "open-ils.circ.hold_request.note.cud");
 784
 785 sub hold_note_CUD {
 786         my($self, $conn, $auth, $note) = @_;
 787
 788     my $e = new_editor(authtoken => $auth, xact => 1);
 789     return $e->die_event unless $e->checkauth;
 790
 791     my $hold = $e->retrieve_action_hold_request($note->hold)
 792         or return $e->die_event;
 793
 794     if($hold->usr ne $e->requestor->id) {
 795         my $usr = $e->retrieve_actor_user($hold->usr);
 796         return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
 797         $note->staff('t') if $note->isnew;
 798     }
 799
 800     if($note->isnew) {
 801         $e->create_action_hold_request_note($note) or return $e->die_event;
 802     } elsif($note->ischanged) {
 803         $e->update_action_hold_request_note($note) or return $e->die_event;
 804     } elsif($note->isdeleted) {
 805         $e->delete_action_hold_request_note($note) or return $e->die_event;
 806     }
 807
 808     $e->commit;
 809     return $note->id;
 810 }
 811
 812
 813
 814 __PACKAGE__->register_method(
 815         method  => "retrieve_hold_status",
 816         api_name        => "open-ils.circ.hold.status.retrieve",
 817         notes           => <<"  NOTE");
 818         Calculates the current status of the hold.
 819         the requestor must have VIEW_HOLD permissions if the hold is for a user
 820         other than the requestor.
 821         Returns -1  on error (for now)
 822         Returns 1 for 'waiting for copy to become available'
 823         Returns 2 for 'waiting for copy capture'
 824         Returns 3 for 'in transit'
 825         Returns 4 for 'arrived'
 826         Returns 5 for 'hold-shelf-delay'
 827         NOTE
 828
 829 sub retrieve_hold_status {
 830         my($self, $client, $auth, $hold_id) = @_;
 831
 832         my $e = new_editor(authtoken => $auth);
 833         return $e->event unless $e->checkauth;
 834         my $hold = $e->retrieve_action_hold_request($hold_id)
 835                 or return $e->event;
 836
 837         if( $e->requestor->id != $hold->usr ) {
 838                 return $e->event unless $e->allowed('VIEW_HOLD');
 839         }
 840
 841         return _hold_status($e, $hold);
 842
 843 }
 844
 845 sub _hold_status {
 846         my($e, $hold) = @_;
 847         return 1 unless $hold->current_copy;
 848         return 2 unless $hold->capture_time;
 849
 850         my $copy = $hold->current_copy;
 851         unless( ref $copy ) {
 852                 $copy = $e->retrieve_asset_copy($hold->current_copy)
 853                         or return $e->event;
 854         }
 855
 856         return 3 if $copy->status == OILS_COPY_STATUS_IN_TRANSIT;
 857
 858         if($copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF) {
 859
 860         my $hs_wait_interval = $U->ou_ancestor_setting_value($hold->pickup_lib, 'circ.hold_shelf_status_delay');
 861         return 4 unless $hs_wait_interval;
 862
 863         # if a hold_shelf_status_delay interval is defined and start_time plus
 864         # the interval is greater than now, consider the hold to be in the virtual
 865         # "on its way to the holds shelf" status. Return 5.
 866
 867         my $transit = $e->search_action_hold_transit_copy({hold => $hold->id})->[0];
 868         my $start_time = ($transit) ? $transit->dest_recv_time : $hold->capture_time;
 869         $start_time = DateTime::Format::ISO8601->new->parse_datetime(clense_ISO8601($start_time));
 870         my $end_time = $start_time->add(seconds => OpenSRF::Utils::interval_to_seconds($hs_wait_interval));
 871
 872         return 5 if $end_time > DateTime->now;
 873         return 4;
 874     }
 875
 876         return -1;
 877 }
 878
 879
 880
 881 __PACKAGE__->register_method(
 882         method  => "retrieve_hold_queue_stats",
 883         api_name        => "open-ils.circ.hold.queue_stats.retrieve",
 884     signature => {
 885         desc => q/
 886             Returns object with total_holds count, queue_position, potential_copies count, and status code
 887         /
 888     }
 889 );
 890
 891 sub retrieve_hold_queue_stats {
 892     my($self, $conn, $auth, $hold_id) = @_;
 893         my $e = new_editor(authtoken => $auth);
 894         return $e->event unless $e->checkauth;
 895         my $hold = $e->retrieve_action_hold_request($hold_id) or return $e->event;
 896         if($e->requestor->id != $hold->usr) {
 897                 return $e->event unless $e->allowed('VIEW_HOLD');
 898         }
 899     return retrieve_hold_queue_status_impl($e, $hold);
 900 }
 901
 902 sub retrieve_hold_queue_status_impl {
 903     my $e = shift;
 904     my $hold = shift;
 905
 906     # The holds queue is defined as the set of holds that share at
 907     # least one potential copy with the context hold
 908     my $q_holds = $e->json_query({
 909          select => {
 910             ahcm => ['hold'],
 911             # fetch request_time since it's in the order_by and we're asking for distinct values
 912             ahr => ['request_time']
 913         },
 914         from => {ahcm => 'ahr'},
 915         order_by => {ahr => ['request_time']},
 916         distinct => 1,
 917         where => {
 918             target_copy => {
 919                 in => {
 920                     select => {ahcm => ['target_copy']},
 921                     from => 'ahcm',
 922                     where => {hold => $hold->id}
 923                 }
 924             }
 925         },
 926     });
 927
 928     my $qpos = 1;
 929     for my $h (@$q_holds) {
 930         last if $h->{hold} == $hold->id;
 931         $qpos++;
 932     }
 933
 934     # total count of potential copies
 935     my $num_potentials = $e->json_query({
 936         select => {ahcm => [{column => 'id', transform => 'count', alias => 'count'}]},
 937         from => 'ahcm',
 938         where => {hold => $hold->id}
 939     })->[0];
 940
 941     my $user_org = $e->json_query({select => {au => ['home_ou']}, from => 'au', where => {id => $hold->usr}})->[0]->{home_ou};
 942     my $default_hold_interval = $U->ou_ancestor_setting_value($user_org, OILS_SETTING_HOLD_ESIMATE_WAIT_INTERVAL);
 943     my $estimated_wait = $qpos * ($default_hold_interval / $num_potentials) if $default_hold_interval;
 944
 945     return {
 946         total_holds => scalar(@$q_holds),
 947         queue_position => $qpos,
 948         potential_copies => $num_potentials,
 949         status => _hold_status($e, $hold),
 950         estimated_wait => int($estimated_wait)
 951     };
 952 }
 953
 954
 955 sub fetch_open_hold_by_current_copy {
 956         my $class = shift;
 957         my $copyid = shift;
 958         my $hold = $apputils->simplereq(
 959                 'open-ils.cstore',
 960                 'open-ils.cstore.direct.action.hold_request.search.atomic',
 961                 { current_copy =>  $copyid , cancel_time => undef, fulfillment_time => undef });
 962         return $hold->[0] if ref($hold);
 963         return undef;
 964 }
 965
 966 sub fetch_related_holds {
 967         my $class = shift;
 968         my $copyid = shift;
 969         return $apputils->simplereq(
 970                 'open-ils.cstore',
 971                 'open-ils.cstore.direct.action.hold_request.search.atomic',
 972                 { current_copy =>  $copyid , cancel_time => undef, fulfillment_time => undef });
 973 }
 974
 975
 976 __PACKAGE__->register_method (
 977         method          => "hold_pull_list",
 978         api_name                => "open-ils.circ.hold_pull_list.retrieve",
 979         signature       => q/
 980                 Returns a list of holds that need to be "pulled"
 981                 by a given location
 982         /
 983 );
 984
 985 __PACKAGE__->register_method (
 986         method          => "hold_pull_list",
 987         api_name                => "open-ils.circ.hold_pull_list.id_list.retrieve",
 988         signature       => q/
 989                 Returns a list of hold ID's that need to be "pulled"
 990                 by a given location
 991         /
 992 );
 993
 994
 995 sub hold_pull_list {
 996         my( $self, $conn, $authtoken, $limit, $offset ) = @_;
 997         my( $reqr, $evt ) = $U->checkses($authtoken);
 998         return $evt if $evt;
 999
1000         my $org = $reqr->ws_ou || $reqr->home_ou;
1001         # the perm locaiton shouldn't really matter here since holds
1002         # will exist all over and VIEW_HOLDS should be universal
1003         $evt = $U->check_perms($reqr->id, $org, 'VIEW_HOLD');
1004         return $evt if $evt;
1005
1006         if( $self->api_name =~ /id_list/ ) {
1007                 return $U->storagereq(
1008                         'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1009                         $org, $limit, $offset );
1010         } else {
1011                 return $U->storagereq(
1012                         'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered.atomic',
1013                         $org, $limit, $offset );
1014         }
1015 }
1016
1017 __PACKAGE__->register_method (
1018         method          => 'fetch_hold_notify',
1019         api_name                => 'open-ils.circ.hold_notification.retrieve_by_hold',
1020     authoritative => 1,
1021         signature       => q/
1022                 Returns a list of hold notification objects based on hold id.
1023                 @param authtoken The loggin session key
1024                 @param holdid The id of the hold whose notifications we want to retrieve
1025                 @return An array of hold notification objects, event on error.
1026         /
1027 );
1028
1029 sub fetch_hold_notify {
1030         my( $self, $conn, $authtoken, $holdid ) = @_;
1031         my( $requestor, $evt ) = $U->checkses($authtoken);
1032         return $evt if $evt;
1033         my ($hold, $patron);
1034         ($hold, $evt) = $U->fetch_hold($holdid);
1035         return $evt if $evt;
1036         ($patron, $evt) = $U->fetch_user($hold->usr);
1037         return $evt if $evt;
1038
1039         $evt = $U->check_perms($requestor->id, $patron->home_ou, 'VIEW_HOLD_NOTIFICATION');
1040         return $evt if $evt;
1041
1042         $logger->info("User ".$requestor->id." fetching hold notifications for hold $holdid");
1043         return $U->cstorereq(
1044                 'open-ils.cstore.direct.action.hold_notification.search.atomic', {hold => $holdid} );
1045 }
1046
1047
1048 __PACKAGE__->register_method (
1049         method          => 'create_hold_notify',
1050         api_name                => 'open-ils.circ.hold_notification.create',
1051         signature       => q/
1052                 Creates a new hold notification object
1053                 @param authtoken The login session key
1054                 @param notification The hold notification object to create
1055                 @return ID of the new object on success, Event on error
1056                 /
1057 );
1058
1059 sub create_hold_notify {
1060    my( $self, $conn, $auth, $note ) = @_;
1061    my $e = new_editor(authtoken=>$auth, xact=>1);
1062    return $e->die_event unless $e->checkauth;
1063
1064    my $hold = $e->retrieve_action_hold_request($note->hold)
1065       or return $e->die_event;
1066    my $patron = $e->retrieve_actor_user($hold->usr)
1067       or return $e->die_event;
1068
1069    return $e->die_event unless
1070       $e->allowed('CREATE_HOLD_NOTIFICATION', $patron->home_ou);
1071
1072         $note->notify_staff($e->requestor->id);
1073    $e->create_action_hold_notification($note) or return $e->die_event;
1074    $e->commit;
1075    return $note->id;
1076 }
1077
1078 __PACKAGE__->register_method (
1079         method          => 'create_hold_note',
1080         api_name                => 'open-ils.circ.hold_note.create',
1081         signature       => q/
1082                 Creates a new hold request note object
1083                 @param authtoken The login session key
1084                 @param note The hold note object to create
1085                 @return ID of the new object on success, Event on error
1086                 /
1087 );
1088
1089 sub create_hold_note {
1090    my( $self, $conn, $auth, $note ) = @_;
1091    my $e = new_editor(authtoken=>$auth, xact=>1);
1092    return $e->die_event unless $e->checkauth;
1093
1094    my $hold = $e->retrieve_action_hold_request($note->hold)
1095       or return $e->die_event;
1096    my $patron = $e->retrieve_actor_user($hold->usr)
1097       or return $e->die_event;
1098
1099    return $e->die_event unless
1100       $e->allowed('UPDATE_HOLD', $patron->home_ou); # FIXME: Using permcrud perm listed in fm_IDL.xml for ahrn.  Probably want something more specific
1101
1102    $e->create_action_hold_request_note($note) or return $e->die_event;
1103    $e->commit;
1104    return $note->id;
1105 }
1106
1107 __PACKAGE__->register_method(
1108         method  => 'reset_hold',
1109         api_name        => 'open-ils.circ.hold.reset',
1110         signature       => q/
1111                 Un-captures and un-targets a hold, essentially returning
1112                 it to the state it was in directly after it was placed,
1113                 then attempts to re-target the hold
1114                 @param authtoken The login session key
1115                 @param holdid The id of the hold
1116         /
1117 );
1118
1119
1120 sub reset_hold {
1121         my( $self, $conn, $auth, $holdid ) = @_;
1122         my $reqr;
1123         my ($hold, $evt) = $U->fetch_hold($holdid);
1124         return $evt if $evt;
1125         ($reqr, $evt) = $U->checksesperm($auth, 'UPDATE_HOLD');
1126         return $evt if $evt;
1127         $evt = _reset_hold($self, $reqr, $hold);
1128         return $evt if $evt;
1129         return 1;
1130 }
1131
1132
1133 __PACKAGE__->register_method(
1134         method  => 'reset_hold_batch',
1135         api_name        => 'open-ils.circ.hold.reset.batch'
1136 );
1137
1138 sub reset_hold_batch {
1139     my($self, $conn, $auth, $hold_ids) = @_;
1140
1141     my $e = new_editor(authtoken => $auth);
1142     return $e->event unless $e->checkauth;
1143
1144     for my $hold_id ($hold_ids) {
1145
1146         my $hold = $e->retrieve_action_hold_request(
1147             [$hold_id, {flesh => 1, flesh_fields => {ahr => ['usr']}}])
1148             or return $e->event;
1149
1150             next unless $e->allowed('UPDATE_HOLD', $hold->usr->home_ou);
1151         _reset_hold($self, $e->requestor, $hold);
1152     }
1153
1154     return 1;
1155 }
1156
1157
1158 sub _reset_hold {
1159         my ($self, $reqr, $hold) = @_;
1160
1161         my $e = new_editor(xact =>1, requestor => $reqr);
1162
1163         $logger->info("reseting hold ".$hold->id);
1164
1165         my $hid = $hold->id;
1166
1167         if( $hold->capture_time and $hold->current_copy ) {
1168
1169                 my $copy = $e->retrieve_asset_copy($hold->current_copy)
1170                         or return $e->event;
1171
1172                 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
1173                         $logger->info("setting copy to status 'reshelving' on hold retarget");
1174                         $copy->status(OILS_COPY_STATUS_RESHELVING);
1175                         $copy->editor($e->requestor->id);
1176                         $copy->edit_date('now');
1177                         $e->update_asset_copy($copy) or return $e->event;
1178
1179                 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
1180
1181                         # We don't want the copy to remain "in transit"
1182                         $copy->status(OILS_COPY_STATUS_RESHELVING);
1183                         $logger->warn("! reseting hold [$hid] that is in transit");
1184                         my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
1185
1186                         if( $transid ) {
1187                                 my $trans = $e->retrieve_action_transit_copy($transid);
1188                                 if( $trans ) {
1189                                         $logger->info("Aborting transit [$transid] on hold [$hid] reset...");
1190                                         my $evt = OpenILS::Application::Circ::Transit::__abort_transit($e, $trans, $copy, 1);
1191                                         $logger->info("Transit abort completed with result $evt");
1192                                         return $evt unless "$evt" eq 1;
1193                                 }
1194                         }
1195                 }
1196         }
1197
1198         $hold->clear_capture_time;
1199         $hold->clear_current_copy;
1200         $hold->clear_shelf_time;
1201
1202         $e->update_action_hold_request($hold) or return $e->event;
1203         $e->commit;
1204
1205         $U->storagereq(
1206                 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1207
1208         return undef;
1209 }
1210
1211
1212 __PACKAGE__->register_method(
1213         method => 'fetch_open_title_holds',
1214         api_name        => 'open-ils.circ.open_holds.retrieve',
1215         signature       => q/
1216                 Returns a list ids of un-fulfilled holds for a given title id
1217                 @param authtoken The login session key
1218                 @param id the id of the item whose holds we want to retrieve
1219                 @param type The hold type - M, T, V, C
1220         /
1221 );
1222
1223 sub fetch_open_title_holds {
1224         my( $self, $conn, $auth, $id, $type, $org ) = @_;
1225         my $e = new_editor( authtoken => $auth );
1226         return $e->event unless $e->checkauth;
1227
1228         $type ||= "T";
1229         $org ||= $e->requestor->ws_ou;
1230
1231 #       return $e->search_action_hold_request(
1232 #               { target => $id, hold_type => $type, fulfillment_time => undef }, {idlist=>1});
1233
1234         # XXX make me return IDs in the future ^--
1235         my $holds = $e->search_action_hold_request(
1236                 {
1237                         target                          => $id,
1238                         cancel_time                     => undef,
1239                         hold_type                       => $type,
1240                         fulfillment_time        => undef
1241                 }
1242         );
1243
1244         flesh_hold_transits($holds);
1245         return $holds;
1246 }
1247
1248
1249 sub flesh_hold_transits {
1250         my $holds = shift;
1251         for my $hold ( @$holds ) {
1252                 $hold->transit(
1253                         $apputils->simplereq(
1254                                 'open-ils.cstore',
1255                                 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
1256                                 { hold => $hold->id },
1257                                 { order_by => { ahtc => 'id desc' }, limit => 1 }
1258                         )->[0]
1259                 );
1260         }
1261 }
1262
1263 sub flesh_hold_notices {
1264         my( $holds, $e ) = @_;
1265         $e ||= new_editor();
1266
1267         for my $hold (@$holds) {
1268                 my $notices = $e->search_action_hold_notification(
1269                         [
1270                                 { hold => $hold->id },
1271                                 { order_by => { anh => 'notify_time desc' } },
1272                         ],
1273                         {idlist=>1}
1274                 );
1275
1276                 $hold->notify_count(scalar(@$notices));
1277                 if( @$notices ) {
1278                         my $n = $e->retrieve_action_hold_notification($$notices[0])
1279                                 or return $e->event;
1280                         $hold->notify_time($n->notify_time);
1281                 }
1282         }
1283 }
1284
1285
1286 __PACKAGE__->register_method(
1287         method => 'fetch_captured_holds',
1288         api_name        => 'open-ils.circ.captured_holds.on_shelf.retrieve',
1289     stream => 1,
1290         signature       => q/
1291                 Returns a list of un-fulfilled holds for a given title id
1292                 @param authtoken The login session key
1293                 @param org The org id of the location in question
1294         /
1295 );
1296
1297 __PACKAGE__->register_method(
1298         method => 'fetch_captured_holds',
1299         api_name        => 'open-ils.circ.captured_holds.id_list.on_shelf.retrieve',
1300     stream => 1,
1301         signature       => q/
1302                 Returns a list ids of un-fulfilled holds for a given title id
1303                 @param authtoken The login session key
1304                 @param org The org id of the location in question
1305         /
1306 );
1307
1308 sub fetch_captured_holds {
1309         my( $self, $conn, $auth, $org ) = @_;
1310
1311         my $e = new_editor(authtoken => $auth);
1312         return $e->event unless $e->checkauth;
1313         return $e->event unless $e->allowed('VIEW_HOLD'); # XXX rely on editor perm
1314
1315         $org ||= $e->requestor->ws_ou;
1316
1317     my $hold_ids = $e->json_query(
1318         {
1319             select => { ahr => ['id'] },
1320             from => {
1321                 ahr => {
1322                     acp => {
1323                         field => 'id',
1324                         fkey => 'current_copy'
1325                     },
1326                 }
1327             },
1328             where => {
1329                 '+acp' => { status => OILS_COPY_STATUS_ON_HOLDS_SHELF },
1330                 '+ahr' => {
1331                     capture_time                => { "!=" => undef },
1332                     current_copy                => { "!=" => undef },
1333                     fulfillment_time    => undef,
1334                     pickup_lib                  => $org,
1335                     cancel_time                 => undef,
1336                 }
1337             }
1338         },
1339     );
1340
1341     for my $hold_id (@$hold_ids) {
1342         if($self->api_name =~ /id_list/) {
1343             $conn->respond($hold_id->{id});
1344             next;
1345         } else {
1346             $conn->respond(
1347                 $e->retrieve_action_hold_request([
1348                     $hold_id->{id},
1349                     {
1350                         flesh => 1,
1351                         flesh_fields => {ahr => ['notifications', 'transit', 'notes']},
1352                         order_by => {anh => 'notify_time desc'}
1353                     }
1354                 ])
1355             );
1356         }
1357     }
1358
1359     return undef;
1360 }
1361 __PACKAGE__->register_method(
1362         method  => "check_title_hold",
1363         api_name        => "open-ils.circ.title_hold.is_possible",
1364         notes           => q/
1365                 Determines if a hold were to be placed by a given user,
1366                 whether or not said hold would have any potential copies
1367                 to fulfill it.
1368                 @param authtoken The login session key
1369                 @param params A hash of named params including:
1370                         patronid  - the id of the hold recipient
1371                         titleid (brn) - the id of the title to be held
1372                         depth   - the hold range depth (defaults to 0)
1373         /);
1374
1375 sub check_title_hold {
1376         my( $self, $client, $authtoken, $params ) = @_;
1377
1378         my %params              = %$params;
1379         my $titleid             = $params{titleid} ||"";
1380         my $volid               = $params{volume_id};
1381         my $copyid              = $params{copy_id};
1382         my $mrid                = $params{mrid} ||"";
1383         my $depth               = $params{depth} || 0;
1384         my $pickup_lib  = $params{pickup_lib};
1385         my $hold_type   = $params{hold_type} || 'T';
1386     my $selection_ou = $params{selection_ou} || $pickup_lib;
1387
1388         my $e = new_editor(authtoken=>$authtoken);
1389         return $e->event unless $e->checkauth;
1390         my $patron = $e->retrieve_actor_user($params{patronid})
1391                 or return $e->event;
1392
1393         if( $e->requestor->id ne $patron->id ) {
1394                 return $e->event unless
1395                         $e->allowed('VIEW_HOLD_PERMIT', $patron->home_ou);
1396         }
1397
1398         return OpenILS::Event->new('PATRON_BARRED') if $U->is_true($patron->barred);
1399
1400         my $request_lib = $e->retrieve_actor_org_unit($e->requestor->ws_ou)
1401                 or return $e->event;
1402
1403     my $soft_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_SOFT_BOUNDARY);
1404     my $hard_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_HARD_BOUNDARY);
1405
1406     if(defined $soft_boundary and $$params{depth} < $soft_boundary) {
1407         # work up the tree and as soon as we find a potential copy, use that depth
1408         # also, make sure we don't go past the hard boundary if it exists
1409
1410         # our min boundary is the greater of user-specified boundary or hard boundary
1411         my $min_depth = (defined $hard_boundary and $hard_boundary > $$params{depth}) ?
1412             $hard_boundary : $$params{depth};
1413
1414         my $depth = $soft_boundary;
1415         while($depth >= $min_depth) {
1416             $logger->info("performing hold possibility check with soft boundary $depth");
1417             my @status = do_possibility_checks($e, $patron, $request_lib, $depth, %params);
1418             return {success => 1, depth => $depth, local_avail => $status[1]} if $status[0];
1419             $depth--;
1420         }
1421         return {success => 0};
1422
1423     } elsif(defined $hard_boundary and $$params{depth} < $hard_boundary) {
1424         # there is no soft boundary, enforce the hard boundary if it exists
1425         $logger->info("performing hold possibility check with hard boundary $hard_boundary");
1426         my @status = do_possibility_checks($e, $patron, $request_lib, $hard_boundary, %params);
1427         if($status[0]) {
1428             return {success => 1, depth => $hard_boundary, local_avail => $status[1]}
1429         } else {
1430             return {success => 0};
1431         }
1432
1433     } else {
1434         # no boundaries defined, fall back to user specifed boundary or no boundary
1435         $logger->info("performing hold possibility check with no boundary");
1436         my @status = do_possibility_checks($e, $patron, $request_lib, $params{depth}, %params);
1437         if($status[0]) {
1438             return {success => 1, depth => $hard_boundary, local_avail => $status[1]};
1439         } else {
1440             return {success => 0};
1441         }
1442     }
1443 }
1444
1445 sub do_possibility_checks {
1446     my($e, $patron, $request_lib, $depth, %params) = @_;
1447
1448         my $titleid             = $params{titleid} ||"";
1449         my $volid               = $params{volume_id};
1450         my $copyid              = $params{copy_id};
1451         my $mrid                = $params{mrid} ||"";
1452         my $pickup_lib  = $params{pickup_lib};
1453         my $hold_type   = $params{hold_type} || 'T';
1454     my $selection_ou = $params{selection_ou} || $pickup_lib;
1455
1456
1457         my $copy;
1458         my $volume;
1459         my $title;
1460
1461         if( $hold_type eq OILS_HOLD_TYPE_COPY ) {
1462
1463                 $copy = $e->retrieve_asset_copy($copyid) or return $e->event;
1464                 $volume = $e->retrieve_asset_call_number($copy->call_number)
1465                         or return $e->event;
1466                 $title = $e->retrieve_biblio_record_entry($volume->record)
1467                         or return $e->event;
1468                 return verify_copy_for_hold(
1469                         $patron, $e->requestor, $title, $copy, $pickup_lib, $request_lib );
1470
1471         } elsif( $hold_type eq OILS_HOLD_TYPE_VOLUME ) {
1472
1473                 $volume = $e->retrieve_asset_call_number($volid)
1474                         or return $e->event;
1475                 $title = $e->retrieve_biblio_record_entry($volume->record)
1476                         or return $e->event;
1477
1478                 return _check_volume_hold_is_possible(
1479                         $volume, $title, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou);
1480
1481         } elsif( $hold_type eq OILS_HOLD_TYPE_TITLE ) {
1482
1483                 return _check_title_hold_is_possible(
1484                         $titleid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou);
1485
1486         } elsif( $hold_type eq OILS_HOLD_TYPE_METARECORD ) {
1487
1488                 my $maps = $e->search_metabib_source_map({metarecord=>$mrid});
1489                 my @recs = map { $_->source } @$maps;
1490                 for my $rec (@recs) {
1491             my @status = _check_title_hold_is_possible(
1492                                 $rec, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou);
1493             return @status if $status[1];
1494                 }
1495                 return (0);
1496         }
1497 }
1498
1499 my %prox_cache;
1500 sub create_ranged_org_filter {
1501     my($e, $selection_ou, $depth) = @_;
1502
1503     # find the orgs from which this hold may be fulfilled,
1504     # based on the selection_ou and depth
1505
1506     my $top_org = $e->search_actor_org_unit([
1507         {parent_ou => undef},
1508         {flesh=>1, flesh_fields=>{aou=>['ou_type']}}])->[0];
1509     my %org_filter;
1510
1511     return () if $depth == $top_org->ou_type->depth;
1512
1513     my $org_list = $U->storagereq('open-ils.storage.actor.org_unit.descendants.atomic', $selection_ou, $depth);
1514     %org_filter = (circ_lib => []);
1515     push(@{$org_filter{circ_lib}}, $_->id) for @$org_list;
1516
1517     $logger->info("hold org filter at depth $depth and selection_ou ".
1518         "$selection_ou created list of @{$org_filter{circ_lib}}");
1519
1520     return %org_filter;
1521 }
1522
1523
1524 sub _check_title_hold_is_possible {
1525         my( $titleid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
1526
1527     my $e = new_editor();
1528     my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
1529
1530     # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
1531     my $copies = $e->json_query(
1532         {
1533             select => { acp => ['id', 'circ_lib'] },
1534             from => {
1535                 acp => {
1536                     acn => {
1537                         field => 'id',
1538                         fkey => 'call_number',
1539                         'join' => {
1540                             bre => {
1541                                 field => 'id',
1542                                 filter => { id => $titleid },
1543                                 fkey => 'record'
1544                             }
1545                         }
1546                     },
1547                     acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
1548                     ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
1549                 }
1550             },
1551             where => {
1552                 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
1553             }
1554         }
1555     );
1556
1557    $logger->info("title possible found ".scalar(@$copies)." potential copies");
1558    return (0) unless @$copies;
1559
1560    # -----------------------------------------------------------------------
1561    # sort the copies into buckets based on their circ_lib proximity to
1562    # the patron's home_ou.
1563    # -----------------------------------------------------------------------
1564
1565    my $home_org = $patron->home_ou;
1566    my $req_org = $request_lib->id;
1567
1568     $logger->info("prox cache $home_org " . $prox_cache{$home_org});
1569
1570     $prox_cache{$home_org} =
1571         $e->search_actor_org_unit_proximity({from_org => $home_org})
1572         unless $prox_cache{$home_org};
1573     my $home_prox = $prox_cache{$home_org};
1574
1575    my %buckets;
1576    my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
1577    push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
1578
1579    my @keys = sort { $a <=> $b } keys %buckets;
1580
1581
1582    if( $home_org ne $req_org ) {
1583       # -----------------------------------------------------------------------
1584       # shove the copies close to the request_lib into the primary buckets
1585       # directly before the farthest away copies.  That way, they are not
1586       # given priority, but they are checked before the farthest copies.
1587       # -----------------------------------------------------------------------
1588         $prox_cache{$req_org} =
1589             $e->search_actor_org_unit_proximity({from_org => $req_org})
1590             unless $prox_cache{$req_org};
1591         my $req_prox = $prox_cache{$req_org};
1592
1593
1594       my %buckets2;
1595       my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
1596       push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
1597
1598       my $highest_key = $keys[@keys - 1];  # the farthest prox in the exising buckets
1599       my $new_key = $highest_key - 0.5; # right before the farthest prox
1600       my @keys2 = sort { $a <=> $b } keys %buckets2;
1601       for my $key (@keys2) {
1602          last if $key >= $highest_key;
1603          push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
1604       }
1605    }
1606
1607    @keys = sort { $a <=> $b } keys %buckets;
1608
1609    my $title;
1610    my %seen;
1611    for my $key (@keys) {
1612       my @cps = @{$buckets{$key}};
1613
1614       $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
1615
1616       for my $copyid (@cps) {
1617
1618          next if $seen{$copyid};
1619          $seen{$copyid} = 1; # there could be dupes given the merged buckets
1620          my $copy = $e->retrieve_asset_copy($copyid);
1621          $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
1622
1623          unless($title) { # grab the title if we don't already have it
1624             my $vol = $e->retrieve_asset_call_number(
1625                [ $copy->call_number, { flesh => 1, flesh_fields => { acn => ['record'] } } ] );
1626             $title = $vol->record;
1627          }
1628
1629          my @status = verify_copy_for_hold(
1630             $patron, $requestor, $title, $copy, $pickup_lib, $request_lib );
1631
1632         return @status if $status[0];
1633       }
1634    }
1635
1636    return (0);
1637 }
1638
1639
1640 sub _check_volume_hold_is_possible {
1641         my( $vol, $title, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
1642     my %org_filter = create_ranged_org_filter(new_editor(), $selection_ou, $depth);
1643         my $copies = new_editor->search_asset_copy({call_number => $vol->id, %org_filter});
1644         $logger->info("checking possibility of volume hold for volume ".$vol->id);
1645         for my $copy ( @$copies ) {
1646         my @status = verify_copy_for_hold(
1647                         $patron, $requestor, $title, $copy, $pickup_lib, $request_lib );
1648         return @status if $status[0];
1649         }
1650         return (0);
1651 }
1652
1653
1654
1655 sub verify_copy_for_hold {
1656         my( $patron, $requestor, $title, $copy, $pickup_lib, $request_lib ) = @_;
1657         $logger->info("checking possibility of copy in hold request for copy ".$copy->id);
1658     my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
1659                 {       patron                          => $patron,
1660                         requestor                       => $requestor,
1661                         copy                            => $copy,
1662                         title                           => $title,
1663                         title_descriptor        => $title->fixed_fields, # this is fleshed into the title object
1664                         pickup_lib                      => $pickup_lib,
1665                         request_lib                     => $request_lib,
1666             new_hold            => 1
1667                 }
1668         );
1669
1670     return (
1671         $permitted,
1672         (
1673                 ($copy->circ_lib == $pickup_lib) and
1674             ($copy->status == OILS_COPY_STATUS_AVAILABLE)
1675         )
1676     );
1677 }
1678
1679
1680
1681 sub find_nearest_permitted_hold {
1682
1683         my $class       = shift;
1684         my $editor      = shift; # CStoreEditor object
1685         my $copy                = shift; # copy to target
1686         my $user                = shift; # staff
1687         my $check_only = shift; # do no updates, just see if the copy could fulfill a hold
1688         my $evt         = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND');
1689
1690         my $bc = $copy->barcode;
1691
1692         # find any existing holds that already target this copy
1693         my $old_holds = $editor->search_action_hold_request(
1694                 {       current_copy => $copy->id,
1695                         cancel_time => undef,
1696                         capture_time => undef
1697                 }
1698         );
1699
1700         # hold->type "R" means we need this copy
1701         for my $h (@$old_holds) { return ($h) if $h->hold_type eq 'R'; }
1702
1703
1704     my $hold_stall_interval = $U->ou_ancestor_setting_value($user->ws_ou, OILS_SETTING_HOLD_SOFT_STALL);
1705
1706         $logger->info("circulator: searching for best hold at org ".$user->ws_ou.
1707         " and copy $bc with a hold stalling interval of ". ($hold_stall_interval || "(none)"));
1708
1709         # search for what should be the best holds for this copy to fulfill
1710         my $best_holds = $U->storagereq(
1711                 "open-ils.storage.action.hold_request.nearest_hold.atomic",
1712                 $user->ws_ou, $copy->id, 10, $hold_stall_interval );
1713
1714         unless(@$best_holds) {
1715
1716                 if( my $hold = $$old_holds[0] ) {
1717                         $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
1718                         return ($hold);
1719                 }
1720
1721                 $logger->info("circulator: no suitable holds found for copy $bc");
1722                 return (undef, $evt);
1723         }
1724
1725
1726         my $best_hold;
1727
1728         # for each potential hold, we have to run the permit script
1729         # to make sure the hold is actually permitted.
1730         for my $holdid (@$best_holds) {
1731                 next unless $holdid;
1732                 $logger->info("circulator: checking if hold $holdid is permitted for copy $bc");
1733
1734                 my $hold = $editor->retrieve_action_hold_request($holdid) or next;
1735                 my $reqr = $editor->retrieve_actor_user($hold->requestor) or next;
1736                 my $rlib = $editor->retrieve_actor_org_unit($hold->request_lib) or next;
1737
1738                 # see if this hold is permitted
1739                 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
1740                         {       patron_id                       => $hold->usr,
1741                                 requestor                       => $reqr,
1742                                 copy                            => $copy,
1743                                 pickup_lib                      => $hold->pickup_lib,
1744                                 request_lib                     => $rlib,
1745                         }
1746                 );
1747
1748                 if( $permitted ) {
1749                         $best_hold = $hold;
1750                         last;
1751                 }
1752         }
1753
1754
1755         unless( $best_hold ) { # no "good" permitted holds were found
1756                 if( my $hold = $$old_holds[0] ) { # can we return a pre-targeted hold?
1757                         $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
1758                         return ($hold);
1759                 }
1760
1761                 # we got nuthin
1762                 $logger->info("circulator: no suitable holds found for copy $bc");
1763                 return (undef, $evt);
1764         }
1765
1766         $logger->info("circulator: best hold ".$best_hold->id." found for copy $bc");
1767
1768         # indicate a permitted hold was found
1769         return $best_hold if $check_only;
1770
1771         # we've found a permitted hold.  we need to "grab" the copy
1772         # to prevent re-targeted holds (next part) from re-grabbing the copy
1773         $best_hold->current_copy($copy->id);
1774         $editor->update_action_hold_request($best_hold)
1775                 or return (undef, $editor->event);
1776
1777
1778     my @retarget;
1779
1780         # re-target any other holds that already target this copy
1781         for my $old_hold (@$old_holds) {
1782                 next if $old_hold->id eq $best_hold->id; # don't re-target the hold we want
1783                 $logger->info("circulator: clearing current_copy and prev_check_time on hold ".
1784             $old_hold->id." after a better hold [".$best_hold->id."] was found");
1785         $old_hold->clear_current_copy;
1786         $old_hold->clear_prev_check_time;
1787         $editor->update_action_hold_request($old_hold)
1788             or return (undef, $editor->event);
1789         push(@retarget, $old_hold->id);
1790         }
1791
1792         return ($best_hold, undef, (@retarget) ? \@retarget : undef);
1793 }
1794
1795
1796
1797
1798
1799
1800 __PACKAGE__->register_method(
1801         method => 'all_rec_holds',
1802         api_name => 'open-ils.circ.holds.retrieve_all_from_title',
1803 );
1804
1805 sub all_rec_holds {
1806         my( $self, $conn, $auth, $title_id, $args ) = @_;
1807
1808         my $e = new_editor(authtoken=>$auth);
1809         $e->checkauth or return $e->event;
1810         $e->allowed('VIEW_HOLD') or return $e->event;
1811
1812         $args ||= {};
1813     $args->{fulfillment_time} = undef; #  we don't want to see old fulfilled holds
1814         $args->{cancel_time} = undef;
1815
1816         my $resp = { volume_holds => [], copy_holds => [], metarecord_holds => [] };
1817
1818     my $mr_map = $e->search_metabib_metarecord_source_map({source => $title_id})->[0];
1819     if($mr_map) {
1820         $resp->{metarecord_holds} = $e->search_action_hold_request(
1821             {   hold_type => OILS_HOLD_TYPE_METARECORD,
1822                 target => $mr_map->metarecord,
1823                 %$args
1824             }, {idlist => 1}
1825         );
1826     }
1827
1828         $resp->{title_holds} = $e->search_action_hold_request(
1829                 {
1830                         hold_type => OILS_HOLD_TYPE_TITLE,
1831                         target => $title_id,
1832                         %$args
1833                 }, {idlist=>1} );
1834
1835         my $vols = $e->search_asset_call_number(
1836                 { record => $title_id, deleted => 'f' }, {idlist=>1});
1837
1838         return $resp unless @$vols;
1839
1840         $resp->{volume_holds} = $e->search_action_hold_request(
1841                 {
1842                         hold_type => OILS_HOLD_TYPE_VOLUME,
1843                         target => $vols,
1844                         %$args },
1845                 {idlist=>1} );
1846
1847         my $copies = $e->search_asset_copy(
1848                 { call_number => $vols, deleted => 'f' }, {idlist=>1});
1849
1850         return $resp unless @$copies;
1851
1852         $resp->{copy_holds} = $e->search_action_hold_request(
1853                 {
1854                         hold_type => OILS_HOLD_TYPE_COPY,
1855                         target => $copies,
1856                         %$args },
1857                 {idlist=>1} );
1858
1859         return $resp;
1860 }
1861
1862
1863
1864
1865
1866 __PACKAGE__->register_method(
1867         method => 'uber_hold',
1868     authoritative => 1,
1869         api_name => 'open-ils.circ.hold.details.retrieve'
1870 );
1871
1872 sub uber_hold {
1873         my($self, $client, $auth, $hold_id) = @_;
1874         my $e = new_editor(authtoken=>$auth);
1875         $e->checkauth or return $e->event;
1876         $e->allowed('VIEW_HOLD') or return $e->event;
1877
1878         my $resp = {};
1879
1880         my $hold = $e->retrieve_action_hold_request(
1881                 [
1882                         $hold_id,
1883                         {
1884                                 flesh => 1,
1885                                 flesh_fields => { ahr => [ 'current_copy', 'usr', 'notes' ] }
1886                         }
1887                 ]
1888         ) or return $e->event;
1889
1890         my $user = $hold->usr;
1891         $hold->usr($user->id);
1892
1893         my $card = $e->retrieve_actor_card($user->card)
1894                 or return $e->event;
1895
1896         my( $mvr, $volume, $copy ) = find_hold_mvr($e, $hold);
1897
1898         flesh_hold_notices([$hold], $e);
1899         flesh_hold_transits([$hold]);
1900
1901     my $details = retrieve_hold_queue_status_impl($e, $hold);
1902
1903         return {
1904                 hold            => $hold,
1905                 copy            => $copy,
1906                 volume  => $volume,
1907                 mvr             => $mvr,
1908                 patron_first => $user->first_given_name,
1909                 patron_last  => $user->family_name,
1910                 patron_barcode => $card->barcode,
1911         %$details
1912         };
1913 }
1914
1915
1916
1917 # -----------------------------------------------------
1918 # Returns the MVR object that represents what the
1919 # hold is all about
1920 # -----------------------------------------------------
1921 sub find_hold_mvr {
1922         my( $e, $hold ) = @_;
1923
1924         my $tid;
1925         my $copy;
1926         my $volume;
1927
1928         if( $hold->hold_type eq OILS_HOLD_TYPE_METARECORD ) {
1929                 my $mr = $e->retrieve_metabib_metarecord($hold->target)
1930                         or return $e->event;
1931                 $tid = $mr->master_record;
1932
1933         } elsif( $hold->hold_type eq OILS_HOLD_TYPE_TITLE ) {
1934                 $tid = $hold->target;
1935
1936         } elsif( $hold->hold_type eq OILS_HOLD_TYPE_VOLUME ) {
1937                 $volume = $e->retrieve_asset_call_number($hold->target)
1938                         or return $e->event;
1939                 $tid = $volume->record;
1940
1941         } elsif( $hold->hold_type eq OILS_HOLD_TYPE_COPY ) {
1942                 $copy = $e->retrieve_asset_copy($hold->target)
1943                         or return $e->event;
1944                 $volume = $e->retrieve_asset_call_number($copy->call_number)
1945                         or return $e->event;
1946                 $tid = $volume->record;
1947         }
1948
1949         if(!$copy and ref $hold->current_copy ) {
1950                 $copy = $hold->current_copy;
1951                 $hold->current_copy($copy->id);
1952         }
1953
1954         if(!$volume and $copy) {
1955                 $volume = $e->retrieve_asset_call_number($copy->call_number);
1956         }
1957
1958     # TODO return metarcord mvr for M holds
1959         my $title = $e->retrieve_biblio_record_entry($tid);
1960         return ( $U->record_to_mvr($title), $volume, $copy );
1961 }
1962
1963
1964
1965
1966 1;