Open-ILS/src/perlmods/lib/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 use Digest::MD5 qw(md5_hex);
  38 use OpenSRF::Utils::Cache;
  39 my $apputils = "OpenILS::Application::AppUtils";
  40 my $U = $apputils;
  41
  42 __PACKAGE__->register_method(
  43     method    => "test_and_create_hold_batch",
  44     api_name  => "open-ils.circ.holds.test_and_create.batch",
  45     stream => 1,
  46     signature => {
  47         desc => q/This is for batch creating a set of holds where every field is identical except for the targets./,
  48         params => [
  49             { desc => 'Authentication token', type => 'string' },
  50             { desc => 'Hash of named parameters.  Same as for open-ils.circ.title_hold.is_possible, though the pertinent target field is automatically populated based on the hold_type and the specified list of targets.', type => 'object'},
  51             { desc => 'Array of target ids', type => 'array' }
  52         ],
  53         return => {
  54             desc => 'Array of hold ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
  55         },
  56     }
  57 );
  58
  59 __PACKAGE__->register_method(
  60     method    => "test_and_create_hold_batch",
  61     api_name  => "open-ils.circ.holds.test_and_create.batch.override",
  62     stream => 1,
  63     signature => {
  64         desc  => '@see open-ils.circ.holds.test_and_create.batch',
  65     }
  66 );
  67
  68
  69 sub test_and_create_hold_batch {
  70         my( $self, $conn, $auth, $params, $target_list ) = @_;
  71
  72         my $override = 1 if $self->api_name =~ /override/;
  73
  74         my $e = new_editor(authtoken=>$auth);
  75         return $e->die_event unless $e->checkauth;
  76     $$params{'requestor'} = $e->requestor->id;
  77
  78     my $target_field;
  79     if ($$params{'hold_type'} eq 'T') { $target_field = 'titleid'; }
  80     elsif ($$params{'hold_type'} eq 'C') { $target_field = 'copy_id'; }
  81     elsif ($$params{'hold_type'} eq 'R') { $target_field = 'copy_id'; }
  82     elsif ($$params{'hold_type'} eq 'F') { $target_field = 'copy_id'; }
  83     elsif ($$params{'hold_type'} eq 'I') { $target_field = 'issuanceid'; }
  84     elsif ($$params{'hold_type'} eq 'V') { $target_field = 'volume_id'; }
  85     elsif ($$params{'hold_type'} eq 'M') { $target_field = 'mrid'; }
  86     elsif ($$params{'hold_type'} eq 'P') { $target_field = 'partid'; }
  87     else { return undef; }
  88
  89     foreach (@$target_list) {
  90         $$params{$target_field} = $_;
  91         my $res;
  92         if (! $override) {
  93             ($res) = $self->method_lookup(
  94                 'open-ils.circ.title_hold.is_possible')->run($auth, $params);
  95         }
  96         if ($override || $res->{'success'} == 1) {
  97             my $ahr = construct_hold_request_object($params);
  98             my ($res2) = $self->method_lookup(
  99                 $override
 100                 ? 'open-ils.circ.holds.create.override'
 101                 : 'open-ils.circ.holds.create'
 102             )->run($auth, $ahr);
 103             $res2 = {
 104                 'target' => $$params{$target_field},
 105                 'result' => $res2
 106             };
 107             $conn->respond($res2);
 108         } else {
 109             $res = {
 110                 'target' => $$params{$target_field},
 111                 'result' => $res
 112             };
 113             $conn->respond($res);
 114         }
 115     }
 116     return undef;
 117 }
 118
 119 sub construct_hold_request_object {
 120     my ($params) = @_;
 121
 122     my $ahr = Fieldmapper::action::hold_request->new;
 123     $ahr->isnew('1');
 124
 125     foreach my $field (keys %{ $params }) {
 126         if ($field eq 'depth') { $ahr->selection_depth($$params{$field}); }
 127         elsif ($field eq 'patronid') {
 128             $ahr->usr($$params{$field}); }
 129         elsif ($field eq 'titleid') { $ahr->target($$params{$field}); }
 130         elsif ($field eq 'copy_id') { $ahr->target($$params{$field}); }
 131         elsif ($field eq 'issuanceid') { $ahr->target($$params{$field}); }
 132         elsif ($field eq 'volume_id') { $ahr->target($$params{$field}); }
 133         elsif ($field eq 'mrid') { $ahr->target($$params{$field}); }
 134         elsif ($field eq 'partid') { $ahr->target($$params{$field}); }
 135         else {
 136             $ahr->$field($$params{$field});
 137         }
 138     }
 139     return $ahr;
 140 }
 141
 142 __PACKAGE__->register_method(
 143     method    => "create_hold_batch",
 144     api_name  => "open-ils.circ.holds.create.batch",
 145     stream => 1,
 146     signature => {
 147         desc => q/@see open-ils.circ.holds.create.batch/,
 148         params => [
 149             { desc => 'Authentication token', type => 'string' },
 150             { desc => 'Array of hold objects', type => 'array' }
 151         ],
 152         return => {
 153             desc => 'Array of hold ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
 154         },
 155     }
 156 );
 157
 158 __PACKAGE__->register_method(
 159     method    => "create_hold_batch",
 160     api_name  => "open-ils.circ.holds.create.override.batch",
 161     stream => 1,
 162     signature => {
 163         desc  => '@see open-ils.circ.holds.create.batch',
 164     }
 165 );
 166
 167
 168 sub create_hold_batch {
 169         my( $self, $conn, $auth, $hold_list ) = @_;
 170     (my $method = $self->api_name) =~ s/\.batch//og;
 171     foreach (@$hold_list) {
 172         my ($res) = $self->method_lookup($method)->run($auth, $_);
 173         $conn->respond($res);
 174     }
 175     return undef;
 176 }
 177
 178
 179 __PACKAGE__->register_method(
 180     method    => "create_hold",
 181     api_name  => "open-ils.circ.holds.create",
 182     signature => {
 183         desc => "Create a new hold for an item.  From a permissions perspective, " .
 184                 "the login session is used as the 'requestor' of the hold.  "      .
 185                 "The hold recipient is determined by the 'usr' setting within the hold object. " .
 186                 'First we verify the requestor has holds request permissions.  '         .
 187                 'Then we verify that the recipient is allowed to make the given hold.  ' .
 188                 'If not, we see if the requestor has "override" capabilities.  If not, ' .
 189                 'a permission exception is returned.  If permissions allow, we cycle '   .
 190                 'through the set of holds objects and create.  '                         .
 191                 'If the recipient does not have permission to place multiple holds '     .
 192                 'on a single title and said operation is attempted, a permission '       .
 193                 'exception is returned',
 194         params => [
 195             { desc => 'Authentication token',               type => 'string' },
 196             { desc => 'Hold object for hold to be created',
 197                 type => 'object', class => 'ahr' }
 198         ],
 199         return => {
 200             desc => 'New ahr ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
 201         },
 202     }
 203 );
 204
 205 __PACKAGE__->register_method(
 206     method    => "create_hold",
 207     api_name  => "open-ils.circ.holds.create.override",
 208     notes     => '@see open-ils.circ.holds.create',
 209     signature => {
 210         desc  => "If the recipient is not allowed to receive the requested hold, " .
 211                  "call this method to attempt the override",
 212         params => [
 213             { desc => 'Authentication token',               type => 'string' },
 214             {
 215                 desc => 'Hold object for hold to be created',
 216                 type => 'object', class => 'ahr'
 217             }
 218         ],
 219         return => {
 220             desc => 'New hold (ahr) ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
 221         },
 222     }
 223 );
 224
 225 sub create_hold {
 226         my( $self, $conn, $auth, $hold ) = @_;
 227     return -1 unless $hold;
 228         my $e = new_editor(authtoken=>$auth, xact=>1);
 229         return $e->die_event unless $e->checkauth;
 230
 231         my $override = 1 if $self->api_name =~ /override/;
 232
 233     my @events;
 234
 235     my $requestor = $e->requestor;
 236     my $recipient = $requestor;
 237
 238     if( $requestor->id ne $hold->usr ) {
 239         # Make sure the requestor is allowed to place holds for
 240         # the recipient if they are not the same people
 241         $recipient = $e->retrieve_actor_user($hold->usr)  or return $e->die_event;
 242         $e->allowed('REQUEST_HOLDS', $recipient->home_ou) or return $e->die_event;
 243     }
 244
 245     # If the related org setting tells us to, block if patron privs have expired
 246     my $expire_setting = $U->ou_ancestor_setting_value($recipient->home_ou, OILS_SETTING_BLOCK_HOLD_FOR_EXPIRED_PATRON);
 247     if ($expire_setting) {
 248         my $expire = DateTime::Format::ISO8601->new->parse_datetime(
 249             cleanse_ISO8601($recipient->expire_date));
 250
 251         push( @events, OpenILS::Event->new(
 252             'PATRON_ACCOUNT_EXPIRED',
 253             "payload" => {"fail_part" => "actor.usr.privs_expired"}
 254             )) if( CORE::time > $expire->epoch ) ;
 255     }
 256
 257     # Now make sure the recipient is allowed to receive the specified hold
 258     my $porg = $recipient->home_ou;
 259     my $rid  = $e->requestor->id;
 260     my $t    = $hold->hold_type;
 261
 262     # See if a duplicate hold already exists
 263     my $sargs = {
 264         usr                     => $recipient->id,
 265         hold_type       => $t,
 266         fulfillment_time => undef,
 267         target          => $hold->target,
 268         cancel_time     => undef,
 269     };
 270
 271     $sargs->{holdable_formats} = $hold->holdable_formats if $t eq 'M';
 272
 273     my $existing = $e->search_action_hold_request($sargs);
 274     push( @events, OpenILS::Event->new('HOLD_EXISTS')) if @$existing;
 275
 276     my $checked_out = hold_item_is_checked_out($e, $recipient->id, $hold->hold_type, $hold->target);
 277     push( @events, OpenILS::Event->new('HOLD_ITEM_CHECKED_OUT')) if $checked_out;
 278
 279     if ( $t eq OILS_HOLD_TYPE_METARECORD ) {
 280         return $e->die_event unless $e->allowed('MR_HOLDS',     $porg);
 281     } elsif ( $t eq OILS_HOLD_TYPE_TITLE ) {
 282         return $e->die_event unless $e->allowed('TITLE_HOLDS',  $porg);
 283     } elsif ( $t eq OILS_HOLD_TYPE_VOLUME ) {
 284         return $e->die_event unless $e->allowed('VOLUME_HOLDS', $porg);
 285     } elsif ( $t eq OILS_HOLD_TYPE_MONOPART ) {
 286         return $e->die_event unless $e->allowed('TITLE_HOLDS', $porg);
 287     } elsif ( $t eq OILS_HOLD_TYPE_ISSUANCE ) {
 288         return $e->die_event unless $e->allowed('ISSUANCE_HOLDS', $porg);
 289     } elsif ( $t eq OILS_HOLD_TYPE_COPY ) {
 290         return $e->die_event unless $e->allowed('COPY_HOLDS',   $porg);
 291     } elsif ( $t eq OILS_HOLD_TYPE_FORCE ) {
 292         return $e->die_event unless $e->allowed('COPY_HOLDS',   $porg);
 293     } elsif ( $t eq OILS_HOLD_TYPE_RECALL ) {
 294         return $e->die_event unless $e->allowed('COPY_HOLDS',   $porg);
 295     }
 296
 297     if( @events ) {
 298         if (!$override) {
 299             $e->rollback;
 300             return \@events;
 301         }
 302         for my $evt (@events) {
 303             next unless $evt;
 304             my $name = $evt->{textcode};
 305             return $e->die_event unless $e->allowed("$name.override", $porg);
 306         }
 307     }
 308
 309     # set the configured expire time
 310     unless($hold->expire_time) {
 311         my $interval = $U->ou_ancestor_setting_value($recipient->home_ou, OILS_SETTING_HOLD_EXPIRE);
 312         if($interval) {
 313             my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
 314             $hold->expire_time($U->epoch2ISO8601($date->epoch));
 315         }
 316     }
 317
 318     $hold->requestor($e->requestor->id);
 319     $hold->request_lib($e->requestor->ws_ou);
 320     $hold->selection_ou($hold->pickup_lib) unless $hold->selection_ou;
 321     $hold = $e->create_action_hold_request($hold) or return $e->die_event;
 322
 323         $e->commit;
 324
 325         $conn->respond_complete($hold->id);
 326
 327     $U->storagereq(
 328         'open-ils.storage.action.hold_request.copy_targeter',
 329         undef, $hold->id ) unless $U->is_true($hold->frozen);
 330
 331         return undef;
 332 }
 333
 334 # makes sure that a user has permission to place the type of requested hold
 335 # returns the Perm exception if not allowed, returns undef if all is well
 336 sub _check_holds_perm {
 337         my($type, $user_id, $org_id) = @_;
 338
 339         my $evt;
 340         if ($type eq "M") {
 341                 $evt = $apputils->check_perms($user_id, $org_id, "MR_HOLDS"    );
 342         } elsif ($type eq "T") {
 343                 $evt = $apputils->check_perms($user_id, $org_id, "TITLE_HOLDS" );
 344         } elsif($type eq "V") {
 345                 $evt = $apputils->check_perms($user_id, $org_id, "VOLUME_HOLDS");
 346         } elsif($type eq "C") {
 347                 $evt = $apputils->check_perms($user_id, $org_id, "COPY_HOLDS"  );
 348         }
 349
 350     return $evt if $evt;
 351         return undef;
 352 }
 353
 354 # tests if the given user is allowed to place holds on another's behalf
 355 sub _check_request_holds_perm {
 356         my $user_id = shift;
 357         my $org_id  = shift;
 358         if (my $evt = $apputils->check_perms(
 359                 $user_id, $org_id, "REQUEST_HOLDS")) {
 360                 return $evt;
 361         }
 362 }
 363
 364 my $ses_is_req_note = 'The login session is the requestor.  If the requestor is different from the user, ' .
 365                       'then the requestor must have VIEW_HOLD permissions';
 366
 367 __PACKAGE__->register_method(
 368     method    => "retrieve_holds_by_id",
 369     api_name  => "open-ils.circ.holds.retrieve_by_id",
 370     signature => {
 371         desc   => "Retrieve the hold, with hold transits attached, for the specified ID.  $ses_is_req_note",
 372         params => [
 373             { desc => 'Authentication token', type => 'string' },
 374             { desc => 'Hold ID',              type => 'number' }
 375         ],
 376         return => {
 377             desc => 'Hold object with transits attached, event on error',
 378         }
 379     }
 380 );
 381
 382
 383 sub retrieve_holds_by_id {
 384         my($self, $client, $auth, $hold_id) = @_;
 385         my $e = new_editor(authtoken=>$auth);
 386         $e->checkauth or return $e->event;
 387         $e->allowed('VIEW_HOLD') or return $e->event;
 388
 389         my $holds = $e->search_action_hold_request(
 390                 [
 391                         { id =>  $hold_id , fulfillment_time => undef },
 392                         {
 393                 order_by => { ahr => "request_time" },
 394                 flesh => 1,
 395                 flesh_fields => {ahr => ['notes']}
 396             }
 397                 ]
 398         );
 399
 400         flesh_hold_transits($holds);
 401         flesh_hold_notices($holds, $e);
 402         return $holds;
 403 }
 404
 405
 406 __PACKAGE__->register_method(
 407     method    => "retrieve_holds",
 408     api_name  => "open-ils.circ.holds.retrieve",
 409     signature => {
 410         desc   => "Retrieves all the holds, with hold transits attached, for the specified user.  $ses_is_req_note",
 411         params => [
 412             { desc => 'Authentication token', type => 'string'  },
 413             { desc => 'User ID',              type => 'integer' }
 414         ],
 415         return => {
 416             desc => 'list of holds, event on error',
 417         }
 418    }
 419 );
 420
 421 __PACKAGE__->register_method(
 422     method        => "retrieve_holds",
 423     api_name      => "open-ils.circ.holds.id_list.retrieve",
 424     authoritative => 1,
 425     signature     => {
 426         desc   => "Retrieves all the hold IDs, for the specified user.  $ses_is_req_note",
 427         params => [
 428             { desc => 'Authentication token', type => 'string'  },
 429             { desc => 'User ID',              type => 'integer' }
 430         ],
 431         return => {
 432             desc => 'list of holds, event on error',
 433         }
 434    }
 435 );
 436
 437 __PACKAGE__->register_method(
 438     method        => "retrieve_holds",
 439     api_name      => "open-ils.circ.holds.canceled.retrieve",
 440     authoritative => 1,
 441     signature     => {
 442         desc   => "Retrieves all the cancelled holds for the specified user.  $ses_is_req_note",
 443         params => [
 444             { desc => 'Authentication token', type => 'string'  },
 445             { desc => 'User ID',              type => 'integer' }
 446         ],
 447         return => {
 448             desc => 'list of holds, event on error',
 449         }
 450    }
 451 );
 452
 453 __PACKAGE__->register_method(
 454     method        => "retrieve_holds",
 455     api_name      => "open-ils.circ.holds.canceled.id_list.retrieve",
 456     authoritative => 1,
 457     signature     => {
 458         desc   => "Retrieves list of cancelled hold IDs for the specified user.  $ses_is_req_note",
 459         params => [
 460             { desc => 'Authentication token', type => 'string'  },
 461             { desc => 'User ID',              type => 'integer' }
 462         ],
 463         return => {
 464             desc => 'list of hold IDs, event on error',
 465         }
 466    }
 467 );
 468
 469
 470 sub retrieve_holds {
 471     my ($self, $client, $auth, $user_id) = @_;
 472
 473     my $e = new_editor(authtoken=>$auth);
 474     return $e->event unless $e->checkauth;
 475     $user_id = $e->requestor->id unless defined $user_id;
 476
 477     my $notes_filter = {staff => 'f'};
 478     my $user = $e->retrieve_actor_user($user_id) or return $e->event;
 479     unless($user_id == $e->requestor->id) {
 480         if($e->allowed('VIEW_HOLD', $user->home_ou)) {
 481             $notes_filter = {staff => 't'}
 482         } else {
 483             my $allowed = OpenILS::Application::Actor::Friends->friend_perm_allowed(
 484                 $e, $user_id, $e->requestor->id, 'hold.view');
 485             return $e->event unless $allowed;
 486         }
 487     } else {
 488         # staff member looking at his/her own holds can see staff and non-staff notes
 489         $notes_filter = {} if $e->allowed('VIEW_HOLD', $user->home_ou);
 490     }
 491
 492     my $holds_query = {
 493         select => {ahr => ['id']},
 494         from => 'ahr',
 495         where => {usr => $user_id, fulfillment_time => undef}
 496     };
 497
 498     if($self->api_name =~ /canceled/) {
 499
 500         # Fetch the canceled holds
 501         # order cancelled holds by cancel time, most recent first
 502
 503         $holds_query->{order_by} = [{class => 'ahr', field => 'cancel_time', direction => 'desc'}];
 504
 505         my $cancel_age;
 506         my $cancel_count = $U->ou_ancestor_setting_value(
 507                 $e->requestor->ws_ou, 'circ.holds.canceled.display_count', $e);
 508
 509         unless($cancel_count) {
 510             $cancel_age = $U->ou_ancestor_setting_value(
 511                 $e->requestor->ws_ou, 'circ.holds.canceled.display_age', $e);
 512
 513             # if no settings are defined, default to last 10 cancelled holds
 514             $cancel_count = 10 unless $cancel_age;
 515         }
 516
 517         if($cancel_count) { # limit by count
 518
 519             $holds_query->{where}->{cancel_time} = {'!=' => undef};
 520             $holds_query->{limit} = $cancel_count;
 521
 522         } elsif($cancel_age) { # limit by age
 523
 524             # find all of the canceled holds that were canceled within the configured time frame
 525             my $date = DateTime->now->subtract(seconds => OpenSRF::Utils::interval_to_seconds($cancel_age));
 526             $date = $U->epoch2ISO8601($date->epoch);
 527             $holds_query->{where}->{cancel_time} = {'>=' => $date};
 528         }
 529
 530     } else {
 531
 532         # order non-cancelled holds by ready-for-pickup, then active, followed by suspended
 533         $holds_query->{order_by} = {ahr => ['shelf_time', 'frozen', 'request_time']};
 534         $holds_query->{where}->{cancel_time} = undef;
 535     }
 536
 537     my $hold_ids = $e->json_query($holds_query);
 538     $hold_ids = [ map { $_->{id} } @$hold_ids ];
 539
 540     return $hold_ids if $self->api_name =~ /id_list/;
 541
 542     my @holds;
 543     for my $hold_id ( @$hold_ids ) {
 544
 545         my $hold = $e->retrieve_action_hold_request($hold_id);
 546         $hold->notes($e->search_action_hold_request_note({hold => $hold_id, %$notes_filter}));
 547
 548         $hold->transit(
 549             $e->search_action_hold_transit_copy([
 550                 {hold => $hold->id},
 551                 {order_by => {ahtc => 'source_send_time desc'}, limit => 1}])->[0]
 552         );
 553
 554         push(@holds, $hold);
 555     }
 556
 557     return \@holds;
 558 }
 559
 560
 561 __PACKAGE__->register_method(
 562     method   => 'user_hold_count',
 563     api_name => 'open-ils.circ.hold.user.count'
 564 );
 565
 566 sub user_hold_count {
 567     my ( $self, $conn, $auth, $userid ) = @_;
 568     my $e = new_editor( authtoken => $auth );
 569     return $e->event unless $e->checkauth;
 570     my $patron = $e->retrieve_actor_user($userid)
 571         or return $e->event;
 572     return $e->event unless $e->allowed( 'VIEW_HOLD', $patron->home_ou );
 573     return __user_hold_count( $self, $e, $userid );
 574 }
 575
 576 sub __user_hold_count {
 577     my ( $self, $e, $userid ) = @_;
 578     my $holds = $e->search_action_hold_request(
 579         {
 580             usr              => $userid,
 581             fulfillment_time => undef,
 582             cancel_time      => undef,
 583         },
 584         { idlist => 1 }
 585     );
 586
 587     return scalar(@$holds);
 588 }
 589
 590
 591 __PACKAGE__->register_method(
 592     method   => "retrieve_holds_by_pickup_lib",
 593     api_name => "open-ils.circ.holds.retrieve_by_pickup_lib",
 594     notes    =>
 595       "Retrieves all the holds, with hold transits attached, for the specified pickup_ou id."
 596 );
 597
 598 __PACKAGE__->register_method(
 599     method   => "retrieve_holds_by_pickup_lib",
 600     api_name => "open-ils.circ.holds.id_list.retrieve_by_pickup_lib",
 601     notes    => "Retrieves all the hold ids for the specified pickup_ou id. "
 602 );
 603
 604 sub retrieve_holds_by_pickup_lib {
 605     my ($self, $client, $login_session, $ou_id) = @_;
 606
 607     #FIXME -- put an appropriate permission check here
 608     #my( $user, $target, $evt ) = $apputils->checkses_requestor(
 609     #   $login_session, $user_id, 'VIEW_HOLD' );
 610     #return $evt if $evt;
 611
 612         my $holds = $apputils->simplereq(
 613                 'open-ils.cstore',
 614                 "open-ils.cstore.direct.action.hold_request.search.atomic",
 615                 {
 616                         pickup_lib =>  $ou_id ,
 617                         fulfillment_time => undef,
 618                         cancel_time => undef
 619                 },
 620                 { order_by => { ahr => "request_time" } }
 621     );
 622
 623     if ( ! $self->api_name =~ /id_list/ ) {
 624         flesh_hold_transits($holds);
 625         return $holds;
 626     }
 627     # else id_list
 628     return [ map { $_->id } @$holds ];
 629 }
 630
 631
 632 __PACKAGE__->register_method(
 633     method   => "uncancel_hold",
 634     api_name => "open-ils.circ.hold.uncancel"
 635 );
 636
 637 sub uncancel_hold {
 638         my($self, $client, $auth, $hold_id) = @_;
 639         my $e = new_editor(authtoken=>$auth, xact=>1);
 640         return $e->die_event unless $e->checkauth;
 641
 642         my $hold = $e->retrieve_action_hold_request($hold_id)
 643                 or return $e->die_event;
 644     return $e->die_event unless $e->allowed('CANCEL_HOLDS', $hold->request_lib);
 645
 646     if ($hold->fulfillment_time) {
 647         $e->rollback;
 648         return 0;
 649     }
 650     unless ($hold->cancel_time) {
 651         $e->rollback;
 652         return 1;
 653     }
 654
 655     # if configured to reset the request time, also reset the expire time
 656     if($U->ou_ancestor_setting_value(
 657         $hold->request_lib, 'circ.holds.uncancel.reset_request_time', $e)) {
 658
 659         $hold->request_time('now');
 660         my $interval = $U->ou_ancestor_setting_value($hold->request_lib, OILS_SETTING_HOLD_EXPIRE);
 661         if($interval) {
 662             my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
 663             $hold->expire_time($U->epoch2ISO8601($date->epoch));
 664         }
 665     }
 666
 667     $hold->clear_cancel_time;
 668     $hold->clear_cancel_cause;
 669     $hold->clear_cancel_note;
 670     $hold->clear_shelf_time;
 671     $hold->clear_current_copy;
 672     $hold->clear_capture_time;
 673     $hold->clear_prev_check_time;
 674     $hold->clear_shelf_expire_time;
 675
 676     $e->update_action_hold_request($hold) or return $e->die_event;
 677     $e->commit;
 678
 679     $U->storagereq('open-ils.storage.action.hold_request.copy_targeter', undef, $hold_id);
 680
 681     return 1;
 682 }
 683
 684
 685 __PACKAGE__->register_method(
 686     method    => "cancel_hold",
 687     api_name  => "open-ils.circ.hold.cancel",
 688     signature => {
 689         desc   => 'Cancels the specified hold.  The login session is the requestor.  If the requestor is different from the usr field ' .
 690                   'on the hold, the requestor must have CANCEL_HOLDS permissions. The hold may be either the hold object or the hold id',
 691         param  => [
 692             {desc => 'Authentication token',  type => 'string'},
 693             {desc => 'Hold ID',               type => 'number'},
 694             {desc => 'Cause of Cancellation', type => 'string'},
 695             {desc => 'Note',                  type => 'string'}
 696         ],
 697         return => {
 698             desc => '1 on success, event on error'
 699         }
 700     }
 701 );
 702
 703 sub cancel_hold {
 704         my($self, $client, $auth, $holdid, $cause, $note) = @_;
 705
 706         my $e = new_editor(authtoken=>$auth, xact=>1);
 707         return $e->die_event unless $e->checkauth;
 708
 709         my $hold = $e->retrieve_action_hold_request($holdid)
 710                 or return $e->die_event;
 711
 712         if( $e->requestor->id ne $hold->usr ) {
 713                 return $e->die_event unless $e->allowed('CANCEL_HOLDS');
 714         }
 715
 716         if ($hold->cancel_time) {
 717         $e->rollback;
 718         return 1;
 719     }
 720
 721         # If the hold is captured, reset the copy status
 722         if( $hold->capture_time and $hold->current_copy ) {
 723
 724                 my $copy = $e->retrieve_asset_copy($hold->current_copy)
 725                         or return $e->die_event;
 726
 727                 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
 728          $logger->info("canceling hold $holdid whose item is on the holds shelf");
 729 #                       $logger->info("setting copy to status 'reshelving' on hold cancel");
 730 #                       $copy->status(OILS_COPY_STATUS_RESHELVING);
 731 #                       $copy->editor($e->requestor->id);
 732 #                       $copy->edit_date('now');
 733 #                       $e->update_asset_copy($copy) or return $e->event;
 734
 735                 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
 736
 737                         my $hid = $hold->id;
 738                         $logger->warn("! canceling hold [$hid] that is in transit");
 739                         my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
 740
 741                         if( $transid ) {
 742                                 my $trans = $e->retrieve_action_transit_copy($transid);
 743                                 # Leave the transit alive, but  set the copy status to
 744                                 # reshelving so it will be properly reshelved when it gets back home
 745                                 if( $trans ) {
 746                                         $trans->copy_status( OILS_COPY_STATUS_RESHELVING );
 747                                         $e->update_action_transit_copy($trans) or return $e->die_event;
 748                                 }
 749                         }
 750                 }
 751         }
 752
 753         $hold->cancel_time('now');
 754     $hold->cancel_cause($cause);
 755     $hold->cancel_note($note);
 756         $e->update_action_hold_request($hold)
 757                 or return $e->die_event;
 758
 759         delete_hold_copy_maps($self, $e, $hold->id);
 760
 761         $e->commit;
 762
 763     # re-fetch the hold to pick up the real cancel_time (not "now") for A/T
 764     $e->xact_begin;
 765     $hold = $e->retrieve_action_hold_request($hold->id) or return $e->die_event;
 766     $e->rollback;
 767
 768     if ($e->requestor->id == $hold->usr) {
 769         $U->create_events_for_hook('hold_request.cancel.patron', $hold, $hold->pickup_lib);
 770     } else {
 771         $U->create_events_for_hook('hold_request.cancel.staff', $hold, $hold->pickup_lib);
 772     }
 773
 774         return 1;
 775 }
 776
 777 sub delete_hold_copy_maps {
 778         my $class  = shift;
 779         my $editor = shift;
 780         my $holdid = shift;
 781
 782         my $maps = $editor->search_action_hold_copy_map({hold=>$holdid});
 783         for(@$maps) {
 784                 $editor->delete_action_hold_copy_map($_)
 785                         or return $editor->event;
 786         }
 787         return undef;
 788 }
 789
 790
 791 my $update_hold_desc = 'The login session is the requestor. '       .
 792    'If the requestor is different from the usr field on the hold, ' .
 793    'the requestor must have UPDATE_HOLDS permissions. '             .
 794    'If supplying a hash of hold data, "id" must be included. '      .
 795    'The hash is ignored if a hold object is supplied, '             .
 796    'so you should supply only one kind of hold data argument.'      ;
 797
 798 __PACKAGE__->register_method(
 799     method    => "update_hold",
 800     api_name  => "open-ils.circ.hold.update",
 801     signature => {
 802         desc   => "Updates the specified hold.  $update_hold_desc",
 803         params => [
 804             {desc => 'Authentication token',         type => 'string'},
 805             {desc => 'Hold Object',                  type => 'object'},
 806             {desc => 'Hash of values to be applied', type => 'object'}
 807         ],
 808         return => {
 809             desc => 'Hold ID on success, event on error',
 810             # type => 'number'
 811         }
 812     }
 813 );
 814
 815 __PACKAGE__->register_method(
 816     method    => "batch_update_hold",
 817     api_name  => "open-ils.circ.hold.update.batch",
 818     stream    => 1,
 819     signature => {
 820         desc   => "Updates the specified hold(s).  $update_hold_desc",
 821         params => [
 822             {desc => 'Authentication token',                    type => 'string'},
 823             {desc => 'Array of hold obejcts',                   type => 'array' },
 824             {desc => 'Array of hashes of values to be applied', type => 'array' }
 825         ],
 826         return => {
 827             desc => 'Hold ID per success, event per error',
 828         }
 829     }
 830 );
 831
 832 sub update_hold {
 833         my($self, $client, $auth, $hold, $values) = @_;
 834     my $e = new_editor(authtoken=>$auth, xact=>1);
 835     return $e->die_event unless $e->checkauth;
 836     my $resp = update_hold_impl($self, $e, $hold, $values);
 837     if ($U->event_code($resp)) {
 838         $e->rollback;
 839         return $resp;
 840     }
 841     $e->commit;     # FIXME: update_hold_impl already does $e->commit  ??
 842     return $resp;
 843 }
 844
 845 sub batch_update_hold {
 846         my($self, $client, $auth, $hold_list, $values_list) = @_;
 847     my $e = new_editor(authtoken=>$auth);
 848     return $e->die_event unless $e->checkauth;
 849
 850     my $count = ($hold_list) ? scalar(@$hold_list) : scalar(@$values_list);     # FIXME: we don't know for sure that we got $values_list.  we could have neither list.
 851     $hold_list   ||= [];
 852     $values_list ||= [];      # FIXME: either move this above $count declaration, or send an event if both lists undef.  Probably the latter.
 853
 854 # FIXME: Failing over to [] guarantees warnings for "Use of unitialized value" in update_hold_impl call.
 855 # FIXME: We should be sure we only call update_hold_impl with hold object OR hash, not both.
 856
 857     for my $idx (0..$count-1) {
 858         $e->xact_begin;
 859         my $resp = update_hold_impl($self, $e, $hold_list->[$idx], $values_list->[$idx]);
 860         $e->xact_commit unless $U->event_code($resp);
 861         $client->respond($resp);
 862     }
 863
 864     $e->disconnect;
 865     return undef;       # not in the register return type, assuming we should always have at least one list populated
 866 }
 867
 868 sub update_hold_impl {
 869     my($self, $e, $hold, $values) = @_;
 870     my $hold_status;
 871
 872     unless($hold) {
 873         $hold = $e->retrieve_action_hold_request($values->{id})
 874             or return $e->die_event;
 875         for my $k (keys %$values) {
 876             if (defined $values->{$k}) {
 877                 $hold->$k($values->{$k});
 878             } else {
 879                 my $f = "clear_$k"; $hold->$f();
 880             }
 881         }
 882     }
 883
 884     my $orig_hold = $e->retrieve_action_hold_request($hold->id)
 885         or return $e->die_event;
 886
 887     # don't allow the user to be changed
 888     return OpenILS::Event->new('BAD_PARAMS') if $hold->usr != $orig_hold->usr;
 889
 890     if($hold->usr ne $e->requestor->id) {
 891         # if the hold is for a different user, make sure the
 892         # requestor has the appropriate permissions
 893         my $usr = $e->retrieve_actor_user($hold->usr)
 894             or return $e->die_event;
 895         return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
 896     }
 897
 898
 899     # --------------------------------------------------------------
 900     # Changing the request time is like playing God
 901     # --------------------------------------------------------------
 902     if($hold->request_time ne $orig_hold->request_time) {
 903         return OpenILS::Event->new('BAD_PARAMS') if $hold->fulfillment_time;
 904         return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
 905     }
 906
 907
 908         # --------------------------------------------------------------
 909         # Code for making sure staff have appropriate permissons for cut_in_line
 910         # This, as is, doesn't prevent a user from cutting their own holds in line
 911         # but needs to
 912         # --------------------------------------------------------------
 913         if($U->is_true($hold->cut_in_line) ne $U->is_true($orig_hold->cut_in_line)) {
 914                 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
 915         }
 916
 917
 918     # --------------------------------------------------------------
 919     # Disallow hold suspencion if the hold is already captured.
 920     # --------------------------------------------------------------
 921     if ($U->is_true($hold->frozen) and not $U->is_true($orig_hold->frozen)) {
 922         $hold_status = _hold_status($e, $hold);
 923         if ($hold_status > 2) { # hold is captured
 924             $logger->info("bypassing hold freeze on captured hold");
 925             return OpenILS::Event->new('HOLD_SUSPEND_AFTER_CAPTURE');
 926         }
 927     }
 928
 929
 930     # --------------------------------------------------------------
 931     # if the hold is on the holds shelf or in transit and the pickup
 932     # lib changes we need to create a new transit.
 933     # --------------------------------------------------------------
 934     if($orig_hold->pickup_lib ne $hold->pickup_lib) {
 935
 936         $hold_status = _hold_status($e, $hold) unless $hold_status;
 937
 938         if($hold_status == 3) { # in transit
 939
 940             return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $orig_hold->pickup_lib);
 941             return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $hold->pickup_lib);
 942
 943             $logger->info("updating pickup lib for hold ".$hold->id." while already in transit");
 944
 945             # update the transit to reflect the new pickup location
 946                         my $transit = $e->search_action_hold_transit_copy(
 947                 {hold=>$hold->id, dest_recv_time => undef})->[0]
 948                 or return $e->die_event;
 949
 950             $transit->prev_dest($transit->dest); # mark the previous destination on the transit
 951             $transit->dest($hold->pickup_lib);
 952             $e->update_action_hold_transit_copy($transit) or return $e->die_event;
 953
 954         } elsif($hold_status == 4) { # on holds shelf
 955
 956             return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $orig_hold->pickup_lib);
 957             return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $hold->pickup_lib);
 958
 959             $logger->info("updating pickup lib for hold ".$hold->id." while on holds shelf");
 960
 961             # create the new transit
 962             my $evt = transit_hold($e, $orig_hold, $hold, $e->retrieve_asset_copy($hold->current_copy));
 963             return $evt if $evt;
 964         }
 965     }
 966
 967     update_hold_if_frozen($self, $e, $hold, $orig_hold);
 968     $e->update_action_hold_request($hold) or return $e->die_event;
 969     $e->commit;
 970
 971     # a change to mint-condition changes the set of potential copies, so retarget the hold;
 972     if($U->is_true($hold->mint_condition) and !$U->is_true($orig_hold->mint_condition)) {
 973         _reset_hold($self, $e->requestor, $hold)
 974     }
 975
 976     return $hold->id;
 977 }
 978
 979 sub transit_hold {
 980     my($e, $orig_hold, $hold, $copy) = @_;
 981     my $src  = $orig_hold->pickup_lib;
 982     my $dest = $hold->pickup_lib;
 983
 984     $logger->info("putting hold into transit on pickup_lib update");
 985
 986     my $transit = Fieldmapper::action::hold_transit_copy->new;
 987     $transit->hold($hold->id);
 988     $transit->source($src);
 989     $transit->dest($dest);
 990     $transit->target_copy($copy->id);
 991     $transit->source_send_time('now');
 992     $transit->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
 993
 994     $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
 995     $copy->editor($e->requestor->id);
 996     $copy->edit_date('now');
 997
 998     $e->create_action_hold_transit_copy($transit) or return $e->die_event;
 999     $e->update_asset_copy($copy) or return $e->die_event;
1000     return undef;
1001 }
1002
1003 # if the hold is frozen, this method ensures that the hold is not "targeted",
1004 # that is, it clears the current_copy and prev_check_time to essentiallly
1005 # reset the hold.  If it is being activated, it runs the targeter in the background
1006 sub update_hold_if_frozen {
1007     my($self, $e, $hold, $orig_hold) = @_;
1008     return if $hold->capture_time;
1009
1010     if($U->is_true($hold->frozen)) {
1011         $logger->info("clearing current_copy and check_time for frozen hold ".$hold->id);
1012         $hold->clear_current_copy;
1013         $hold->clear_prev_check_time;
1014
1015     } else {
1016         if($U->is_true($orig_hold->frozen)) {
1017             $logger->info("Running targeter on activated hold ".$hold->id);
1018             $U->storagereq( 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1019         }
1020     }
1021 }
1022
1023 __PACKAGE__->register_method(
1024     method    => "hold_note_CUD",
1025     api_name  => "open-ils.circ.hold_request.note.cud",
1026     signature => {
1027         desc   => 'Create, update or delete a hold request note.  If the operator (from Auth. token) '
1028                 . 'is not the owner of the hold, the UPDATE_HOLD permission is required',
1029         params => [
1030             { desc => 'Authentication token', type => 'string' },
1031             { desc => 'Hold note object',     type => 'object' }
1032         ],
1033         return => {
1034             desc => 'Returns the note ID, event on error'
1035         },
1036     }
1037 );
1038
1039 sub hold_note_CUD {
1040         my($self, $conn, $auth, $note) = @_;
1041
1042     my $e = new_editor(authtoken => $auth, xact => 1);
1043     return $e->die_event unless $e->checkauth;
1044
1045     my $hold = $e->retrieve_action_hold_request($note->hold)
1046         or return $e->die_event;
1047
1048     if($hold->usr ne $e->requestor->id) {
1049         my $usr = $e->retrieve_actor_user($hold->usr);
1050         return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
1051         $note->staff('t') if $note->isnew;
1052     }
1053
1054     if($note->isnew) {
1055         $e->create_action_hold_request_note($note) or return $e->die_event;
1056     } elsif($note->ischanged) {
1057         $e->update_action_hold_request_note($note) or return $e->die_event;
1058     } elsif($note->isdeleted) {
1059         $e->delete_action_hold_request_note($note) or return $e->die_event;
1060     }
1061
1062     $e->commit;
1063     return $note->id;
1064 }
1065
1066
1067 __PACKAGE__->register_method(
1068     method    => "retrieve_hold_status",
1069     api_name  => "open-ils.circ.hold.status.retrieve",
1070     signature => {
1071         desc   => 'Calculates the current status of the hold. The requestor must have '      .
1072                   'VIEW_HOLD permissions if the hold is for a user other than the requestor' ,
1073         param  => [
1074             { desc => 'Hold ID', type => 'number' }
1075         ],
1076         return => {
1077             # type => 'number',     # event sometimes
1078             desc => <<'END_OF_DESC'
1079 Returns event on error or:
1080 -1 on error (for now),
1081  1 for 'waiting for copy to become available',
1082  2 for 'waiting for copy capture',
1083  3 for 'in transit',
1084  4 for 'arrived',
1085  5 for 'hold-shelf-delay'
1086  6 for 'canceled'
1087 END_OF_DESC
1088         }
1089     }
1090 );
1091
1092 sub retrieve_hold_status {
1093         my($self, $client, $auth, $hold_id) = @_;
1094
1095         my $e = new_editor(authtoken => $auth);
1096         return $e->event unless $e->checkauth;
1097         my $hold = $e->retrieve_action_hold_request($hold_id)
1098                 or return $e->event;
1099
1100         if( $e->requestor->id != $hold->usr ) {
1101                 return $e->event unless $e->allowed('VIEW_HOLD');
1102         }
1103
1104         return _hold_status($e, $hold);
1105
1106 }
1107
1108 sub _hold_status {
1109         my($e, $hold) = @_;
1110     if ($hold->cancel_time) {
1111         return 6;
1112     }
1113         return 1 unless $hold->current_copy;
1114         return 2 unless $hold->capture_time;
1115
1116         my $copy = $hold->current_copy;
1117         unless( ref $copy ) {
1118                 $copy = $e->retrieve_asset_copy($hold->current_copy)
1119                         or return $e->event;
1120         }
1121
1122         return 3 if $copy->status == OILS_COPY_STATUS_IN_TRANSIT;
1123
1124         if($copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF) {
1125
1126         my $hs_wait_interval = $U->ou_ancestor_setting_value($hold->pickup_lib, 'circ.hold_shelf_status_delay');
1127         return 4 unless $hs_wait_interval;
1128
1129         # if a hold_shelf_status_delay interval is defined and start_time plus
1130         # the interval is greater than now, consider the hold to be in the virtual
1131         # "on its way to the holds shelf" status. Return 5.
1132
1133         my $transit    = $e->search_action_hold_transit_copy({hold => $hold->id})->[0];
1134         my $start_time = ($transit) ? $transit->dest_recv_time : $hold->capture_time;
1135         $start_time    = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time));
1136         my $end_time   = $start_time->add(seconds => OpenSRF::Utils::interval_to_seconds($hs_wait_interval));
1137
1138         return 5 if $end_time > DateTime->now;
1139         return 4;
1140     }
1141
1142     return -1;  # error
1143 }
1144
1145
1146
1147 __PACKAGE__->register_method(
1148     method    => "retrieve_hold_queue_stats",
1149     api_name  => "open-ils.circ.hold.queue_stats.retrieve",
1150     signature => {
1151         desc   => 'Returns summary data about the state of a hold',
1152         params => [
1153             { desc => 'Authentication token',  type => 'string'},
1154             { desc => 'Hold ID', type => 'number'},
1155         ],
1156         return => {
1157             desc => q/Summary object with keys:
1158                 total_holds : total holds in queue
1159                 queue_position : current queue position
1160                 potential_copies : number of potential copies for this hold
1161                 estimated_wait : estimated wait time in days
1162                 status : hold status
1163                      -1 => error or unexpected state,
1164                      1 => 'waiting for copy to become available',
1165                      2 => 'waiting for copy capture',
1166                      3 => 'in transit',
1167                      4 => 'arrived',
1168                      5 => 'hold-shelf-delay'
1169             /,
1170             type => 'object'
1171         }
1172     }
1173 );
1174
1175 sub retrieve_hold_queue_stats {
1176     my($self, $conn, $auth, $hold_id) = @_;
1177         my $e = new_editor(authtoken => $auth);
1178         return $e->event unless $e->checkauth;
1179         my $hold = $e->retrieve_action_hold_request($hold_id) or return $e->event;
1180         if($e->requestor->id != $hold->usr) {
1181                 return $e->event unless $e->allowed('VIEW_HOLD');
1182         }
1183     return retrieve_hold_queue_status_impl($e, $hold);
1184 }
1185
1186 sub retrieve_hold_queue_status_impl {
1187     my $e = shift;
1188     my $hold = shift;
1189
1190     # The holds queue is defined as the distinct set of holds that share at
1191     # least one potential copy with the context hold, plus any holds that
1192     # share the same hold type and target.  The latter part exists to
1193     # accomodate holds that currently have no potential copies
1194     my $q_holds = $e->json_query({
1195
1196         # fetch cut_in_line and request_time since they're in the order_by
1197         # and we're asking for distinct values
1198         select => {ahr => ['id', 'cut_in_line', 'request_time']},
1199         from   => {
1200             ahr => {
1201                 'ahcm' => {
1202                     join => {
1203                         'ahcm2' => {
1204                             'class' => 'ahcm',
1205                             'field' => 'target_copy',
1206                             'fkey'  => 'target_copy'
1207                         }
1208                     }
1209                 }
1210             }
1211         },
1212         order_by => [
1213             {
1214                 "class" => "ahr",
1215                 "field" => "cut_in_line",
1216                 "transform" => "coalesce",
1217                 "params" => [ 0 ],
1218                 "direction" => "desc"
1219             },
1220             { "class" => "ahr", "field" => "request_time" }
1221         ],
1222         distinct => 1,
1223         where => {
1224             '+ahcm2' => { hold => $hold->id }
1225         }
1226     });
1227
1228     if (!@$q_holds) { # none? maybe we don't have a map ...
1229         $q_holds = $e->json_query({
1230             select => {ahr => ['id', 'cut_in_line', 'request_time']},
1231             from   => 'ahr',
1232             order_by => [
1233                 {
1234                     "class" => "ahr",
1235                     "field" => "cut_in_line",
1236                     "transform" => "coalesce",
1237                     "params" => [ 0 ],
1238                     "direction" => "desc"
1239                 },
1240                 { "class" => "ahr", "field" => "request_time" }
1241             ],
1242             where    => {
1243                 hold_type => $hold->hold_type,
1244                 target    => $hold->target
1245            }
1246         });
1247     }
1248
1249
1250     my $qpos = 1;
1251     for my $h (@$q_holds) {
1252         last if $h->{id} == $hold->id;
1253         $qpos++;
1254     }
1255
1256     my $hold_data = $e->json_query({
1257         select => {
1258             acp => [ {column => 'id', transform => 'count', aggregate => 1, alias => 'count'} ],
1259             ccm => [ {column =>'avg_wait_time'} ]
1260         },
1261         from => {
1262             ahcm => {
1263                 acp => {
1264                     join => {
1265                         ccm => {type => 'left'}
1266                     }
1267                 }
1268             }
1269         },
1270         where => {'+ahcm' => {hold => $hold->id} }
1271     });
1272
1273     my $user_org = $e->json_query({select => {au => ['home_ou']}, from => 'au', where => {id => $hold->usr}})->[0]->{home_ou};
1274
1275     my $default_wait = $U->ou_ancestor_setting_value($user_org, OILS_SETTING_HOLD_ESIMATE_WAIT_INTERVAL);
1276     my $min_wait = $U->ou_ancestor_setting_value($user_org, 'circ.holds.min_estimated_wait_interval');
1277     $min_wait = OpenSRF::Utils::interval_to_seconds($min_wait || '0 seconds');
1278     $default_wait ||= '0 seconds';
1279
1280     # Estimated wait time is the average wait time across the set
1281     # of potential copies, divided by the number of potential copies
1282     # times the queue position.
1283
1284     my $combined_secs = 0;
1285     my $num_potentials = 0;
1286
1287     for my $wait_data (@$hold_data) {
1288         my $count += $wait_data->{count};
1289         $combined_secs += $count *
1290             OpenSRF::Utils::interval_to_seconds($wait_data->{avg_wait_time} || $default_wait);
1291         $num_potentials += $count;
1292     }
1293
1294     my $estimated_wait = -1;
1295
1296     if($num_potentials) {
1297         my $avg_wait = $combined_secs / $num_potentials;
1298         $estimated_wait = $qpos * ($avg_wait / $num_potentials);
1299         $estimated_wait = $min_wait if $estimated_wait < $min_wait and $estimated_wait != -1;
1300     }
1301
1302     return {
1303         total_holds      => scalar(@$q_holds),
1304         queue_position   => $qpos,
1305         potential_copies => $num_potentials,
1306         status           => _hold_status( $e, $hold ),
1307         estimated_wait   => int($estimated_wait)
1308     };
1309 }
1310
1311
1312 sub fetch_open_hold_by_current_copy {
1313         my $class = shift;
1314         my $copyid = shift;
1315         my $hold = $apputils->simplereq(
1316                 'open-ils.cstore',
1317                 'open-ils.cstore.direct.action.hold_request.search.atomic',
1318                 { current_copy =>  $copyid , cancel_time => undef, fulfillment_time => undef });
1319         return $hold->[0] if ref($hold);
1320         return undef;
1321 }
1322
1323 sub fetch_related_holds {
1324         my $class = shift;
1325         my $copyid = shift;
1326         return $apputils->simplereq(
1327                 'open-ils.cstore',
1328                 'open-ils.cstore.direct.action.hold_request.search.atomic',
1329                 { current_copy =>  $copyid , cancel_time => undef, fulfillment_time => undef });
1330 }
1331
1332
1333 __PACKAGE__->register_method(
1334     method    => "hold_pull_list",
1335     api_name  => "open-ils.circ.hold_pull_list.retrieve",
1336     signature => {
1337         desc   => 'Returns (reference to) a list of holds that need to be "pulled" by a given location. ' .
1338                   'The location is determined by the login session.',
1339         params => [
1340             { desc => 'Limit (optional)',  type => 'number'},
1341             { desc => 'Offset (optional)', type => 'number'},
1342         ],
1343         return => {
1344             desc => 'reference to a list of holds, or event on failure',
1345         }
1346     }
1347 );
1348
1349 __PACKAGE__->register_method(
1350     method    => "hold_pull_list",
1351     api_name  => "open-ils.circ.hold_pull_list.id_list.retrieve",
1352     signature => {
1353         desc   => 'Returns (reference to) a list of holds IDs that need to be "pulled" by a given location. ' .
1354                   'The location is determined by the login session.',
1355         params => [
1356             { desc => 'Limit (optional)',  type => 'number'},
1357             { desc => 'Offset (optional)', type => 'number'},
1358         ],
1359         return => {
1360             desc => 'reference to a list of holds, or event on failure',
1361         }
1362     }
1363 );
1364
1365 __PACKAGE__->register_method(
1366     method    => "hold_pull_list",
1367     api_name  => "open-ils.circ.hold_pull_list.retrieve.count",
1368     signature => {
1369         desc   => 'Returns a count of holds that need to be "pulled" by a given location. ' .
1370                   'The location is determined by the login session.',
1371         params => [
1372             { desc => 'Limit (optional)',  type => 'number'},
1373             { desc => 'Offset (optional)', type => 'number'},
1374         ],
1375         return => {
1376             desc => 'Holds count (integer), or event on failure',
1377             # type => 'number'
1378         }
1379     }
1380 );
1381
1382
1383 sub hold_pull_list {
1384         my( $self, $conn, $authtoken, $limit, $offset ) = @_;
1385         my( $reqr, $evt ) = $U->checkses($authtoken);
1386         return $evt if $evt;
1387
1388         my $org = $reqr->ws_ou || $reqr->home_ou;
1389         # the perm locaiton shouldn't really matter here since holds
1390         # will exist all over and VIEW_HOLDS should be universal
1391         $evt = $U->check_perms($reqr->id, $org, 'VIEW_HOLD');
1392         return $evt if $evt;
1393
1394     if($self->api_name =~ /count/) {
1395
1396                 my $count = $U->storagereq(
1397                         'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.status_filtered.count',
1398                         $org, $limit, $offset );
1399
1400         $logger->info("Grabbing pull list for org unit $org with $count items");
1401         return $count;
1402
1403     } elsif( $self->api_name =~ /id_list/ ) {
1404                 return $U->storagereq(
1405                         'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1406                         $org, $limit, $offset );
1407
1408         } else {
1409                 return $U->storagereq(
1410                         'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered.atomic',
1411                         $org, $limit, $offset );
1412         }
1413 }
1414
1415 __PACKAGE__->register_method(
1416     method    => "print_hold_pull_list",
1417     api_name  => "open-ils.circ.hold_pull_list.print",
1418     signature => {
1419         desc   => 'Returns an HTML-formatted holds pull list',
1420         params => [
1421             { desc => 'Authtoken', type => 'string'},
1422             { desc => 'Org unit ID.  Optional, defaults to workstation org unit', type => 'number'},
1423         ],
1424         return => {
1425             desc => 'HTML string',
1426             type => 'string'
1427         }
1428     }
1429 );
1430
1431 sub print_hold_pull_list {
1432     my($self, $client, $auth, $org_id) = @_;
1433
1434     my $e = new_editor(authtoken=>$auth);
1435     return $e->event unless $e->checkauth;
1436
1437     $org_id = (defined $org_id) ? $org_id : $e->requestor->ws_ou;
1438     return $e->event unless $e->allowed('VIEW_HOLD', $org_id);
1439
1440     my $hold_ids = $U->storagereq(
1441         'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1442         $org_id, 10000);
1443
1444     return undef unless @$hold_ids;
1445
1446     $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1447
1448     # Holds will /NOT/ be in order after this ...
1449     my $holds = $e->search_action_hold_request({id => $hold_ids}, {substream => 1});
1450     $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1451
1452     # ... so we must resort.
1453     my $hold_map = +{map { $_->id => $_ } @$holds};
1454     my $sorted_holds = [];
1455     push @$sorted_holds, $hold_map->{$_} foreach @$hold_ids;
1456
1457     return $U->fire_object_event(
1458         undef, "ahr.format.pull_list", $sorted_holds,
1459         $org_id, undef, undef, $client
1460     );
1461
1462 }
1463
1464 __PACKAGE__->register_method(
1465     method    => "print_hold_pull_list_stream",
1466     stream   => 1,
1467     api_name  => "open-ils.circ.hold_pull_list.print.stream",
1468     signature => {
1469         desc   => 'Returns a stream of fleshed holds',
1470         params => [
1471             { desc => 'Authtoken', type => 'string'},
1472             { desc => 'Hash of optional param: Org unit ID (defaults to workstation org unit), limit, offset, sort (array of: acplo.position, prefix, call_number, suffix, request_time)',
1473               type => 'object'
1474             },
1475         ],
1476         return => {
1477             desc => 'A stream of fleshed holds',
1478             type => 'object'
1479         }
1480     }
1481 );
1482
1483 sub print_hold_pull_list_stream {
1484     my($self, $client, $auth, $params) = @_;
1485
1486     my $e = new_editor(authtoken=>$auth);
1487     return $e->die_event unless $e->checkauth;
1488
1489     delete($$params{org_id}) unless (int($$params{org_id}));
1490     delete($$params{limit}) unless (int($$params{limit}));
1491     delete($$params{offset}) unless (int($$params{offset}));
1492     delete($$params{chunk_size}) unless (int($$params{chunk_size}));
1493     delete($$params{chunk_size}) if  ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
1494     $$params{chunk_size} ||= 10;
1495
1496     $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
1497     return $e->die_event unless $e->allowed('VIEW_HOLD', $$params{org_id });
1498
1499     my $sort = [];
1500     if ($$params{sort} && @{ $$params{sort} }) {
1501         for my $s (@{ $$params{sort} }) {
1502             if ($s eq 'acplo.position') {
1503                 push @$sort, {
1504                     "class" => "acplo", "field" => "position",
1505                     "transform" => "coalesce", "params" => [999]
1506                 };
1507             } elsif ($s eq 'prefix') {
1508                 push @$sort, {"class" => "acnp", "field" => "label_sortkey"};
1509             } elsif ($s eq 'call_number') {
1510                 push @$sort, {"class" => "acn", "field" => "label_sortkey"};
1511             } elsif ($s eq 'suffix') {
1512                 push @$sort, {"class" => "acns", "field" => "label_sortkey"};
1513             } elsif ($s eq 'request_time') {
1514                 push @$sort, {"class" => "ahr", "field" => "request_time"};
1515             }
1516         }
1517     } else {
1518         push @$sort, {"class" => "ahr", "field" => "request_time"};
1519     }
1520
1521     my $holds_ids = $e->json_query(
1522         {
1523             "select" => {"ahr" => ["id"]},
1524             "from" => {
1525                 "ahr" => {
1526                     "acp" => {
1527                         "field" => "id",
1528                         "fkey" => "current_copy",
1529                         "filter" => {
1530                             "circ_lib" => $$params{org_id}, "status" => [0,7]
1531                         },
1532                         "join" => {
1533                             "acn" => {
1534                                 "field" => "id",
1535                                 "fkey" => "call_number",
1536                                 "join" => {
1537                                     "acnp" => {
1538                                         "field" => "id",
1539                                         "fkey" => "prefix"
1540                                     },
1541                                     "acns" => {
1542                                         "field" => "id",
1543                                         "fkey" => "suffix"
1544                                     }
1545                                 }
1546                             },
1547                             "acplo" => {
1548                                 "field" => "org",
1549                                 "fkey" => "circ_lib",
1550                                 "type" => "left",
1551                                 "filter" => {
1552                                     "location" => {"=" => {"+acp" => "location"}}
1553                                 }
1554                             }
1555                         }
1556                     }
1557                 }
1558             },
1559             "where" => {
1560                 "+ahr" => {
1561                     "capture_time" => undef,
1562                     "cancel_time" => undef,
1563                     "-or" => [
1564                         {"expire_time" => undef },
1565                         {"expire_time" => {">" => "now"}}
1566                     ]
1567                 }
1568             },
1569             (@$sort ? (order_by => $sort) : ()),
1570             ($$params{limit} ? (limit => $$params{limit}) : ()),
1571             ($$params{offset} ? (offset => $$params{offset}) : ())
1572         }, {"substream" => 1}
1573     ) or return $e->die_event;
1574
1575     $logger->info("about to stream back " . scalar(@$holds_ids) . " holds");
1576
1577     my @chunk;
1578     for my $hid (@$holds_ids) {
1579         push @chunk, $e->retrieve_action_hold_request([
1580             $hid->{"id"}, {
1581                 "flesh" => 3,
1582                 "flesh_fields" => {
1583                     "ahr" => ["usr", "current_copy"],
1584                     "au"  => ["card"],
1585                     "acp" => ["location", "call_number", "parts"],
1586                     "acn" => ["record","prefix","suffix"]
1587                 }
1588             }
1589         ]);
1590
1591         if (@chunk >= $$params{chunk_size}) {
1592             $client->respond( \@chunk );
1593             @chunk = ();
1594         }
1595     }
1596     $client->respond_complete( \@chunk ) if (@chunk);
1597     $e->disconnect;
1598     return undef;
1599 }
1600
1601
1602
1603 __PACKAGE__->register_method(
1604     method        => 'fetch_hold_notify',
1605     api_name      => 'open-ils.circ.hold_notification.retrieve_by_hold',
1606     authoritative => 1,
1607     signature     => q/
1608 Returns a list of hold notification objects based on hold id.
1609 @param authtoken The loggin session key
1610 @param holdid The id of the hold whose notifications we want to retrieve
1611 @return An array of hold notification objects, event on error.
1612 /
1613 );
1614
1615 sub fetch_hold_notify {
1616         my( $self, $conn, $authtoken, $holdid ) = @_;
1617         my( $requestor, $evt ) = $U->checkses($authtoken);
1618         return $evt if $evt;
1619         my ($hold, $patron);
1620         ($hold, $evt) = $U->fetch_hold($holdid);
1621         return $evt if $evt;
1622         ($patron, $evt) = $U->fetch_user($hold->usr);
1623         return $evt if $evt;
1624
1625         $evt = $U->check_perms($requestor->id, $patron->home_ou, 'VIEW_HOLD_NOTIFICATION');
1626         return $evt if $evt;
1627
1628         $logger->info("User ".$requestor->id." fetching hold notifications for hold $holdid");
1629         return $U->cstorereq(
1630                 'open-ils.cstore.direct.action.hold_notification.search.atomic', {hold => $holdid} );
1631 }
1632
1633
1634 __PACKAGE__->register_method(
1635     method    => 'create_hold_notify',
1636     api_name  => 'open-ils.circ.hold_notification.create',
1637     signature => q/
1638 Creates a new hold notification object
1639 @param authtoken The login session key
1640 @param notification The hold notification object to create
1641 @return ID of the new object on success, Event on error
1642 /
1643 );
1644
1645 sub create_hold_notify {
1646    my( $self, $conn, $auth, $note ) = @_;
1647    my $e = new_editor(authtoken=>$auth, xact=>1);
1648    return $e->die_event unless $e->checkauth;
1649
1650    my $hold = $e->retrieve_action_hold_request($note->hold)
1651       or return $e->die_event;
1652    my $patron = $e->retrieve_actor_user($hold->usr)
1653       or return $e->die_event;
1654
1655    return $e->die_event unless
1656       $e->allowed('CREATE_HOLD_NOTIFICATION', $patron->home_ou);
1657
1658    $note->notify_staff($e->requestor->id);
1659    $e->create_action_hold_notification($note) or return $e->die_event;
1660    $e->commit;
1661    return $note->id;
1662 }
1663
1664 __PACKAGE__->register_method(
1665     method    => 'create_hold_note',
1666     api_name  => 'open-ils.circ.hold_note.create',
1667     signature => q/
1668                 Creates a new hold request note object
1669                 @param authtoken The login session key
1670                 @param note The hold note object to create
1671                 @return ID of the new object on success, Event on error
1672                 /
1673 );
1674
1675 sub create_hold_note {
1676    my( $self, $conn, $auth, $note ) = @_;
1677    my $e = new_editor(authtoken=>$auth, xact=>1);
1678    return $e->die_event unless $e->checkauth;
1679
1680    my $hold = $e->retrieve_action_hold_request($note->hold)
1681       or return $e->die_event;
1682    my $patron = $e->retrieve_actor_user($hold->usr)
1683       or return $e->die_event;
1684
1685    return $e->die_event unless
1686       $e->allowed('UPDATE_HOLD', $patron->home_ou); # FIXME: Using permcrud perm listed in fm_IDL.xml for ahrn.  Probably want something more specific
1687
1688    $e->create_action_hold_request_note($note) or return $e->die_event;
1689    $e->commit;
1690    return $note->id;
1691 }
1692
1693 __PACKAGE__->register_method(
1694     method    => 'reset_hold',
1695     api_name  => 'open-ils.circ.hold.reset',
1696     signature => q/
1697                 Un-captures and un-targets a hold, essentially returning
1698                 it to the state it was in directly after it was placed,
1699                 then attempts to re-target the hold
1700                 @param authtoken The login session key
1701                 @param holdid The id of the hold
1702         /
1703 );
1704
1705
1706 sub reset_hold {
1707         my( $self, $conn, $auth, $holdid ) = @_;
1708         my $reqr;
1709         my ($hold, $evt) = $U->fetch_hold($holdid);
1710         return $evt if $evt;
1711         ($reqr, $evt) = $U->checksesperm($auth, 'UPDATE_HOLD');
1712         return $evt if $evt;
1713         $evt = _reset_hold($self, $reqr, $hold);
1714         return $evt if $evt;
1715         return 1;
1716 }
1717
1718
1719 __PACKAGE__->register_method(
1720     method   => 'reset_hold_batch',
1721     api_name => 'open-ils.circ.hold.reset.batch'
1722 );
1723
1724 sub reset_hold_batch {
1725     my($self, $conn, $auth, $hold_ids) = @_;
1726
1727     my $e = new_editor(authtoken => $auth);
1728     return $e->event unless $e->checkauth;
1729
1730     for my $hold_id ($hold_ids) {
1731
1732         my $hold = $e->retrieve_action_hold_request(
1733             [$hold_id, {flesh => 1, flesh_fields => {ahr => ['usr']}}])
1734             or return $e->event;
1735
1736             next unless $e->allowed('UPDATE_HOLD', $hold->usr->home_ou);
1737         _reset_hold($self, $e->requestor, $hold);
1738     }
1739
1740     return 1;
1741 }
1742
1743
1744 sub _reset_hold {
1745         my ($self, $reqr, $hold) = @_;
1746
1747         my $e = new_editor(xact =>1, requestor => $reqr);
1748
1749         $logger->info("reseting hold ".$hold->id);
1750
1751         my $hid = $hold->id;
1752
1753         if( $hold->capture_time and $hold->current_copy ) {
1754
1755                 my $copy = $e->retrieve_asset_copy($hold->current_copy)
1756                         or return $e->die_event;
1757
1758                 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
1759                         $logger->info("setting copy to status 'reshelving' on hold retarget");
1760                         $copy->status(OILS_COPY_STATUS_RESHELVING);
1761                         $copy->editor($e->requestor->id);
1762                         $copy->edit_date('now');
1763                         $e->update_asset_copy($copy) or return $e->die_event;
1764
1765                 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
1766
1767                         # We don't want the copy to remain "in transit"
1768                         $copy->status(OILS_COPY_STATUS_RESHELVING);
1769                         $logger->warn("! reseting hold [$hid] that is in transit");
1770                         my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
1771
1772                         if( $transid ) {
1773                                 my $trans = $e->retrieve_action_transit_copy($transid);
1774                                 if( $trans ) {
1775                                         $logger->info("Aborting transit [$transid] on hold [$hid] reset...");
1776                                         my $evt = OpenILS::Application::Circ::Transit::__abort_transit($e, $trans, $copy, 1);
1777                                         $logger->info("Transit abort completed with result $evt");
1778                                         unless ("$evt" eq 1) {
1779                         $e->rollback;
1780                                             return $evt;
1781                     }
1782                                 }
1783                         }
1784                 }
1785         }
1786
1787         $hold->clear_capture_time;
1788         $hold->clear_current_copy;
1789         $hold->clear_shelf_time;
1790         $hold->clear_shelf_expire_time;
1791
1792         $e->update_action_hold_request($hold) or return $e->die_event;
1793         $e->commit;
1794
1795         $U->storagereq(
1796                 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1797
1798         return undef;
1799 }
1800
1801
1802 __PACKAGE__->register_method(
1803     method    => 'fetch_open_title_holds',
1804     api_name  => 'open-ils.circ.open_holds.retrieve',
1805     signature => q/
1806                 Returns a list ids of un-fulfilled holds for a given title id
1807                 @param authtoken The login session key
1808                 @param id the id of the item whose holds we want to retrieve
1809                 @param type The hold type - M, T, I, V, C, F, R
1810         /
1811 );
1812
1813 sub fetch_open_title_holds {
1814         my( $self, $conn, $auth, $id, $type, $org ) = @_;
1815         my $e = new_editor( authtoken => $auth );
1816         return $e->event unless $e->checkauth;
1817
1818         $type ||= "T";
1819         $org  ||= $e->requestor->ws_ou;
1820
1821 #       return $e->search_action_hold_request(
1822 #               { target => $id, hold_type => $type, fulfillment_time => undef }, {idlist=>1});
1823
1824         # XXX make me return IDs in the future ^--
1825         my $holds = $e->search_action_hold_request(
1826                 {
1827                         target                          => $id,
1828                         cancel_time                     => undef,
1829                         hold_type                       => $type,
1830                         fulfillment_time        => undef
1831                 }
1832         );
1833
1834         flesh_hold_transits($holds);
1835         return $holds;
1836 }
1837
1838
1839 sub flesh_hold_transits {
1840         my $holds = shift;
1841         for my $hold ( @$holds ) {
1842                 $hold->transit(
1843                         $apputils->simplereq(
1844                                 'open-ils.cstore',
1845                                 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
1846                                 { hold => $hold->id },
1847                                 { order_by => { ahtc => 'id desc' }, limit => 1 }
1848                         )->[0]
1849                 );
1850         }
1851 }
1852
1853 sub flesh_hold_notices {
1854         my( $holds, $e ) = @_;
1855         $e ||= new_editor();
1856
1857         for my $hold (@$holds) {
1858                 my $notices = $e->search_action_hold_notification(
1859                         [
1860                                 { hold => $hold->id },
1861                                 { order_by => { anh => 'notify_time desc' } },
1862                         ],
1863                         {idlist=>1}
1864                 );
1865
1866                 $hold->notify_count(scalar(@$notices));
1867                 if( @$notices ) {
1868                         my $n = $e->retrieve_action_hold_notification($$notices[0])
1869                                 or return $e->event;
1870                         $hold->notify_time($n->notify_time);
1871                 }
1872         }
1873 }
1874
1875
1876 __PACKAGE__->register_method(
1877     method    => 'fetch_captured_holds',
1878     api_name  => 'open-ils.circ.captured_holds.on_shelf.retrieve',
1879     stream    => 1,
1880     authoritative => 1,
1881     signature => q/
1882                 Returns a list of un-fulfilled holds (on the Holds Shelf) for a given title id
1883                 @param authtoken The login session key
1884                 @param org The org id of the location in question
1885         /
1886 );
1887
1888 __PACKAGE__->register_method(
1889     method    => 'fetch_captured_holds',
1890     api_name  => 'open-ils.circ.captured_holds.id_list.on_shelf.retrieve',
1891     stream    => 1,
1892     authoritative => 1,
1893     signature => q/
1894                 Returns list ids of un-fulfilled holds (on the Holds Shelf) for a given title id
1895                 @param authtoken The login session key
1896                 @param org The org id of the location in question
1897         /
1898 );
1899
1900 __PACKAGE__->register_method(
1901     method    => 'fetch_captured_holds',
1902     api_name  => 'open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve',
1903     stream    => 1,
1904     authoritative => 1,
1905     signature => q/
1906                 Returns list ids of shelf-expired un-fulfilled holds for a given title id
1907                 @param authtoken The login session key
1908                 @param org The org id of the location in question
1909         /
1910 );
1911
1912
1913 sub fetch_captured_holds {
1914         my( $self, $conn, $auth, $org ) = @_;
1915
1916         my $e = new_editor(authtoken => $auth);
1917         return $e->die_event unless $e->checkauth;
1918         return $e->die_event unless $e->allowed('VIEW_HOLD'); # XXX rely on editor perm
1919
1920         $org ||= $e->requestor->ws_ou;
1921
1922     my $query = {
1923         select => { alhr => ['id'] },
1924         from   => {
1925             alhr => {
1926                 acp => {
1927                     field => 'id',
1928                     fkey  => 'current_copy'
1929                 },
1930             }
1931         },
1932         where => {
1933             '+acp' => { status => OILS_COPY_STATUS_ON_HOLDS_SHELF },
1934             '+alhr' => {
1935                 capture_time     => { "!=" => undef },
1936                 current_copy     => { "!=" => undef },
1937                 fulfillment_time => undef,
1938                 pickup_lib       => $org,
1939 #                cancel_time      => undef,
1940               }
1941         }
1942     };
1943     if($self->api_name =~ /expired/) {
1944 #       $query->{'where'}->{'+ahr'}->{'shelf_expire_time'} = {'<' => 'now'};
1945         $query->{'where'}->{'+alhr'}->{'shelf_time'} = {'!=' => undef};
1946         $query->{'where'}->{'+alhr'}->{'-or'} = {
1947                 shelf_expire_time => { '<' => 'now'},
1948                 cancel_time => { '!=' => undef },
1949         };
1950     }
1951     my $hold_ids = $e->json_query( $query );
1952
1953     for my $hold_id (@$hold_ids) {
1954         if($self->api_name =~ /id_list/) {
1955             $conn->respond($hold_id->{id});
1956             next;
1957         } else {
1958             $conn->respond(
1959                 $e->retrieve_action_hold_request([
1960                     $hold_id->{id},
1961                     {
1962                         flesh => 1,
1963                         flesh_fields => {ahr => ['notifications', 'transit', 'notes']},
1964                         order_by => {anh => 'notify_time desc'}
1965                     }
1966                 ])
1967             );
1968         }
1969     }
1970
1971     return undef;
1972 }
1973
1974 __PACKAGE__->register_method(
1975     method    => "print_expired_holds_stream",
1976     api_name  => "open-ils.circ.captured_holds.expired.print.stream",
1977     stream    => 1
1978 );
1979
1980 sub print_expired_holds_stream {
1981     my ($self, $client, $auth, $params) = @_;
1982
1983     # No need to check specific permissions: we're going to call another method
1984     # that will do that.
1985     my $e = new_editor("authtoken" => $auth);
1986     return $e->die_event unless $e->checkauth;
1987
1988     delete($$params{org_id}) unless (int($$params{org_id}));
1989     delete($$params{limit}) unless (int($$params{limit}));
1990     delete($$params{offset}) unless (int($$params{offset}));
1991     delete($$params{chunk_size}) unless (int($$params{chunk_size}));
1992     delete($$params{chunk_size}) if  ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
1993     $$params{chunk_size} ||= 10;
1994
1995     $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
1996
1997     my @hold_ids = $self->method_lookup(
1998         "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
1999     )->run($auth, $params->{"org_id"});
2000
2001     if (!@hold_ids) {
2002         $e->disconnect;
2003         return;
2004     } elsif (defined $U->event_code($hold_ids[0])) {
2005         $e->disconnect;
2006         return $hold_ids[0];
2007     }
2008
2009     $logger->info("about to stream back up to " . scalar(@hold_ids) . " expired holds");
2010
2011     while (@hold_ids) {
2012         my @hid_chunk = splice @hold_ids, 0, $params->{"chunk_size"};
2013
2014         my $result_chunk = $e->json_query({
2015             "select" => {
2016                 "acp" => ["barcode"],
2017                 "au" => [qw/
2018                     first_given_name second_given_name family_name alias
2019                 /],
2020                 "acn" => ["label"],
2021                 "bre" => ["marc"],
2022                 "acpl" => ["name"]
2023             },
2024             "from" => {
2025                 "ahr" => {
2026                     "acp" => {
2027                         "field" => "id", "fkey" => "current_copy",
2028                         "join" => {
2029                             "acn" => {
2030                                 "field" => "id", "fkey" => "call_number",
2031                                 "join" => {
2032                                     "bre" => {
2033                                         "field" => "id", "fkey" => "record"
2034                                     }
2035                                 }
2036                             },
2037                             "acpl" => {"field" => "id", "fkey" => "location"}
2038                         }
2039                     },
2040                     "au" => {"field" => "id", "fkey" => "usr"}
2041                 }
2042             },
2043             "where" => {"+ahr" => {"id" => \@hid_chunk}}
2044         }) or return $e->die_event;
2045         $client->respond($result_chunk);
2046     }
2047
2048     $e->disconnect;
2049     undef;
2050 }
2051
2052 __PACKAGE__->register_method(
2053     method    => "check_title_hold_batch",
2054     api_name  => "open-ils.circ.title_hold.is_possible.batch",
2055     stream    => 1,
2056     signature => {
2057         desc  => '@see open-ils.circ.title_hold.is_possible.batch',
2058         params => [
2059             { desc => 'Authentication token',     type => 'string'},
2060             { desc => 'Array of Hash of named parameters', type => 'array'},
2061         ],
2062         return => {
2063             desc => 'Array of response objects',
2064             type => 'array'
2065         }
2066     }
2067 );
2068
2069 sub check_title_hold_batch {
2070     my($self, $client, $authtoken, $param_list) = @_;
2071     foreach (@$param_list) {
2072         my ($res) = $self->method_lookup('open-ils.circ.title_hold.is_possible')->run($authtoken, $_);
2073         $client->respond($res);
2074     }
2075     return undef;
2076 }
2077
2078
2079 __PACKAGE__->register_method(
2080     method    => "check_title_hold",
2081     api_name  => "open-ils.circ.title_hold.is_possible",
2082     signature => {
2083         desc  => 'Determines if a hold were to be placed by a given user, ' .
2084              'whether or not said hold would have any potential copies to fulfill it.' .
2085              'The named paramaters of the second argument include: ' .
2086              'patronid, titleid, volume_id, copy_id, mrid, depth, pickup_lib, hold_type, selection_ou. ' .
2087              'See perldoc ' . __PACKAGE__ . ' for more info on these fields.' ,
2088         params => [
2089             { desc => 'Authentication token',     type => 'string'},
2090             { desc => 'Hash of named parameters', type => 'object'},
2091         ],
2092         return => {
2093             desc => 'List of new message IDs (empty if none)',
2094             type => 'array'
2095         }
2096     }
2097 );
2098
2099 =head3 check_title_hold (token, hash)
2100
2101 The named fields in the hash are:
2102
2103  patronid     - ID of the hold recipient  (required)
2104  depth        - hold range depth          (default 0)
2105  pickup_lib   - destination for hold, fallback value for selection_ou
2106  selection_ou - ID of org_unit establishing hard and soft hold boundary settings
2107  issuanceid   - ID of the issuance to be held, required for Issuance level hold
2108  partid       - ID of the monograph part to be held, required for monograph part level hold
2109  titleid      - ID (BRN) of the title to be held, required for Title level hold
2110  volume_id    - required for Volume level hold
2111  copy_id      - required for Copy level hold
2112  mrid         - required for Meta-record level hold
2113  hold_type    - T, C (or R or F), I, V or M for Title, Copy, Issuance, Volume or Meta-record  (default "T")
2114
2115 All key/value pairs are passed on to do_possibility_checks.
2116
2117 =cut
2118
2119 # FIXME: better params checking.  what other params are required, if any?
2120 # FIXME: 3 copies of values confusing: $x, $params->{x} and $params{x}
2121 # FIXME: for example, $depth gets a default value, but then $$params{depth} is still
2122 # used in conditionals, where it may be undefined, causing a warning.
2123 # FIXME: specify proper usage/interaction of selection_ou and pickup_lib
2124
2125 sub check_title_hold {
2126     my( $self, $client, $authtoken, $params ) = @_;
2127     my $e = new_editor(authtoken=>$authtoken);
2128     return $e->event unless $e->checkauth;
2129
2130     my %params       = %$params;
2131     my $depth        = $params{depth}        || 0;
2132     my $selection_ou = $params{selection_ou} || $params{pickup_lib};
2133
2134         my $patron = $e->retrieve_actor_user($params{patronid})
2135                 or return $e->event;
2136
2137         if( $e->requestor->id ne $patron->id ) {
2138                 return $e->event unless
2139                         $e->allowed('VIEW_HOLD_PERMIT', $patron->home_ou);
2140         }
2141
2142         return OpenILS::Event->new('PATRON_BARRED') if $U->is_true($patron->barred);
2143
2144         my $request_lib = $e->retrieve_actor_org_unit($e->requestor->ws_ou)
2145                 or return $e->event;
2146
2147     my $soft_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_SOFT_BOUNDARY);
2148     my $hard_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_HARD_BOUNDARY);
2149
2150     my @status = ();
2151     my $return_depth = $hard_boundary; # default depth to return on success
2152     if(defined $soft_boundary and $depth < $soft_boundary) {
2153         # work up the tree and as soon as we find a potential copy, use that depth
2154         # also, make sure we don't go past the hard boundary if it exists
2155
2156         # our min boundary is the greater of user-specified boundary or hard boundary
2157         my $min_depth = (defined $hard_boundary and $hard_boundary > $depth) ?
2158             $hard_boundary : $depth;
2159
2160         my $depth = $soft_boundary;
2161         while($depth >= $min_depth) {
2162             $logger->info("performing hold possibility check with soft boundary $depth");
2163             @status = do_possibility_checks($e, $patron, $request_lib, $depth, %params);
2164             if ($status[0]) {
2165                 $return_depth = $depth;
2166                 last;
2167             }
2168             $depth--;
2169         }
2170     } elsif(defined $hard_boundary and $depth < $hard_boundary) {
2171         # there is no soft boundary, enforce the hard boundary if it exists
2172         $logger->info("performing hold possibility check with hard boundary $hard_boundary");
2173         @status = do_possibility_checks($e, $patron, $request_lib, $hard_boundary, %params);
2174     } else {
2175         # no boundaries defined, fall back to user specifed boundary or no boundary
2176         $logger->info("performing hold possibility check with no boundary");
2177         @status = do_possibility_checks($e, $patron, $request_lib, $params{depth}, %params);
2178     }
2179
2180     if ($status[0]) {
2181         return {
2182             "success" => 1,
2183             "depth" => $return_depth,
2184             "local_avail" => $status[1]
2185         };
2186     } elsif ($status[2]) {
2187         my $n = scalar @{$status[2]};
2188         return {"success" => 0, "last_event" => $status[2]->[$n - 1]};
2189     } else {
2190         return {"success" => 0};
2191     }
2192 }
2193
2194
2195
2196 sub do_possibility_checks {
2197     my($e, $patron, $request_lib, $depth, %params) = @_;
2198
2199     my $issuanceid   = $params{issuanceid}      || "";
2200     my $partid       = $params{partid}      || "";
2201     my $titleid      = $params{titleid}      || "";
2202     my $volid        = $params{volume_id};
2203     my $copyid       = $params{copy_id};
2204     my $mrid         = $params{mrid}         || "";
2205     my $pickup_lib   = $params{pickup_lib};
2206     my $hold_type    = $params{hold_type}    || 'T';
2207     my $selection_ou = $params{selection_ou} || $pickup_lib;
2208     my $holdable_formats = $params{holdable_formats};
2209
2210
2211         my $copy;
2212         my $volume;
2213         my $title;
2214
2215         if( $hold_type eq OILS_HOLD_TYPE_FORCE || $hold_type eq OILS_HOLD_TYPE_RECALL || $hold_type eq OILS_HOLD_TYPE_COPY ) {
2216
2217         return $e->event unless $copy   = $e->retrieve_asset_copy($copyid);
2218         return $e->event unless $volume = $e->retrieve_asset_call_number($copy->call_number);
2219         return $e->event unless $title  = $e->retrieve_biblio_record_entry($volume->record);
2220
2221         return verify_copy_for_hold(
2222             $patron, $e->requestor, $title, $copy, $pickup_lib, $request_lib
2223         );
2224
2225         } elsif( $hold_type eq OILS_HOLD_TYPE_VOLUME ) {
2226
2227                 return $e->event unless $volume = $e->retrieve_asset_call_number($volid);
2228                 return $e->event unless $title  = $e->retrieve_biblio_record_entry($volume->record);
2229
2230                 return _check_volume_hold_is_possible(
2231                         $volume, $title, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2232         );
2233
2234         } elsif( $hold_type eq OILS_HOLD_TYPE_TITLE ) {
2235
2236                 return _check_title_hold_is_possible(
2237                         $titleid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2238         );
2239
2240         } elsif( $hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
2241
2242                 return _check_issuance_hold_is_possible(
2243                         $issuanceid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2244         );
2245
2246         } elsif( $hold_type eq OILS_HOLD_TYPE_MONOPART ) {
2247
2248                 return _check_monopart_hold_is_possible(
2249                         $partid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2250         );
2251
2252         } elsif( $hold_type eq OILS_HOLD_TYPE_METARECORD ) {
2253
2254                 my $maps = $e->search_metabib_metarecord_source_map({metarecord=>$mrid});
2255                 my @recs = map { $_->source } @$maps;
2256                 my @status = ();
2257                 for my $rec (@recs) {
2258                         @status = _check_title_hold_is_possible(
2259                                 $rec, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $holdable_formats
2260                         );
2261                         last if $status[0];
2262                 }
2263                 return @status;
2264         }
2265 #   else { Unrecognized hold_type ! }   # FIXME: return error? or 0?
2266 }
2267
2268 my %prox_cache;
2269 sub create_ranged_org_filter {
2270     my($e, $selection_ou, $depth) = @_;
2271
2272     # find the orgs from which this hold may be fulfilled,
2273     # based on the selection_ou and depth
2274
2275     my $top_org = $e->search_actor_org_unit([
2276         {parent_ou => undef},
2277         {flesh=>1, flesh_fields=>{aou=>['ou_type']}}])->[0];
2278     my %org_filter;
2279
2280     return () if $depth == $top_org->ou_type->depth;
2281
2282     my $org_list = $U->storagereq('open-ils.storage.actor.org_unit.descendants.atomic', $selection_ou, $depth);
2283     %org_filter = (circ_lib => []);
2284     push(@{$org_filter{circ_lib}}, $_->id) for @$org_list;
2285
2286     $logger->info("hold org filter at depth $depth and selection_ou ".
2287         "$selection_ou created list of @{$org_filter{circ_lib}}");
2288
2289     return %org_filter;
2290 }
2291
2292
2293 sub _check_title_hold_is_possible {
2294     my( $titleid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $holdable_formats ) = @_;
2295
2296     my ($types, $formats, $lang);
2297     if (defined($holdable_formats)) {
2298         ($types, $formats, $lang) = split '-', $holdable_formats;
2299     }
2300
2301     my $e = new_editor();
2302     my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2303
2304     # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2305     my $copies = $e->json_query(
2306         {
2307             select => { acp => ['id', 'circ_lib'] },
2308               from => {
2309                 acp => {
2310                     acn => {
2311                         field  => 'id',
2312                         fkey   => 'call_number',
2313                         'join' => {
2314                             bre => {
2315                                 field  => 'id',
2316                                 filter => { id => $titleid },
2317                                 fkey   => 'record'
2318                             },
2319                             mrd => {
2320                                 field  => 'record',
2321                                 fkey   => 'record',
2322                                 filter => {
2323                                     record => $titleid,
2324                                     ( $types   ? (item_type => [split '', $types])   : () ),
2325                                     ( $formats ? (item_form => [split '', $formats]) : () ),
2326                                     ( $lang    ? (item_lang => $lang)                : () )
2327                                 }
2328                             }
2329                         }
2330                     },
2331                     acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2332                     ccs  => { field => 'id', filter => { holdable => 't'}, fkey => 'status'   },
2333                     acpm => { field => 'target_copy', type => 'left' } # ignore part-linked copies
2334                 }
2335             },
2336             where => {
2337                 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter },
2338                 '+acpm' => { target_copy => undef } # ignore part-linked copies
2339             }
2340         }
2341     );
2342
2343     $logger->info("title possible found ".scalar(@$copies)." potential copies");
2344     return (
2345         0, 0, [
2346             new OpenILS::Event(
2347                 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2348                 "payload" => {"fail_part" => "no_ultimate_items"}
2349             )
2350         ]
2351     ) unless @$copies;
2352
2353     # -----------------------------------------------------------------------
2354     # sort the copies into buckets based on their circ_lib proximity to
2355     # the patron's home_ou.
2356     # -----------------------------------------------------------------------
2357
2358     my $home_org = $patron->home_ou;
2359     my $req_org = $request_lib->id;
2360
2361     $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2362
2363     $prox_cache{$home_org} =
2364         $e->search_actor_org_unit_proximity({from_org => $home_org})
2365         unless $prox_cache{$home_org};
2366     my $home_prox = $prox_cache{$home_org};
2367
2368     my %buckets;
2369     my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2370     push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2371
2372     my @keys = sort { $a <=> $b } keys %buckets;
2373
2374
2375     if( $home_org ne $req_org ) {
2376       # -----------------------------------------------------------------------
2377       # shove the copies close to the request_lib into the primary buckets
2378       # directly before the farthest away copies.  That way, they are not
2379       # given priority, but they are checked before the farthest copies.
2380       # -----------------------------------------------------------------------
2381         $prox_cache{$req_org} =
2382             $e->search_actor_org_unit_proximity({from_org => $req_org})
2383             unless $prox_cache{$req_org};
2384         my $req_prox = $prox_cache{$req_org};
2385
2386         my %buckets2;
2387         my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2388         push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2389
2390         my $highest_key = $keys[@keys - 1];  # the farthest prox in the exising buckets
2391         my $new_key = $highest_key - 0.5; # right before the farthest prox
2392         my @keys2   = sort { $a <=> $b } keys %buckets2;
2393         for my $key (@keys2) {
2394             last if $key >= $highest_key;
2395             push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2396         }
2397     }
2398
2399     @keys = sort { $a <=> $b } keys %buckets;
2400
2401     my $title;
2402     my %seen;
2403     my @status;
2404     OUTER: for my $key (@keys) {
2405       my @cps = @{$buckets{$key}};
2406
2407       $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2408
2409       for my $copyid (@cps) {
2410
2411          next if $seen{$copyid};
2412          $seen{$copyid} = 1; # there could be dupes given the merged buckets
2413          my $copy = $e->retrieve_asset_copy($copyid);
2414          $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2415
2416          unless($title) { # grab the title if we don't already have it
2417             my $vol = $e->retrieve_asset_call_number(
2418                [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2419             $title = $vol->record;
2420          }
2421
2422          @status = verify_copy_for_hold(
2423             $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2424
2425          last OUTER if $status[0];
2426       }
2427     }
2428
2429     return @status;
2430 }
2431
2432 sub _check_issuance_hold_is_possible {
2433     my( $issuanceid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2434
2435     my $e = new_editor();
2436     my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2437
2438     # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2439     my $copies = $e->json_query(
2440         {
2441             select => { acp => ['id', 'circ_lib'] },
2442               from => {
2443                 acp => {
2444                     sitem => {
2445                         field  => 'unit',
2446                         fkey   => 'id',
2447                         filter => { issuance => $issuanceid }
2448                     },
2449                     acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2450                     ccs  => { field => 'id', filter => { holdable => 't'}, fkey => 'status'   }
2451                 }
2452             },
2453             where => {
2454                 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2455             },
2456             distinct => 1
2457         }
2458     );
2459
2460     $logger->info("issuance possible found ".scalar(@$copies)." potential copies");
2461
2462     my $empty_ok;
2463     if (!@$copies) {
2464         $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2465         $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2466
2467         return (
2468             0, 0, [
2469                 new OpenILS::Event(
2470                     "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2471                     "payload" => {"fail_part" => "no_ultimate_items"}
2472                 )
2473             ]
2474         ) unless $empty_ok;
2475
2476         return (1, 0);
2477     }
2478
2479     # -----------------------------------------------------------------------
2480     # sort the copies into buckets based on their circ_lib proximity to
2481     # the patron's home_ou.
2482     # -----------------------------------------------------------------------
2483
2484     my $home_org = $patron->home_ou;
2485     my $req_org = $request_lib->id;
2486
2487     $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2488
2489     $prox_cache{$home_org} =
2490         $e->search_actor_org_unit_proximity({from_org => $home_org})
2491         unless $prox_cache{$home_org};
2492     my $home_prox = $prox_cache{$home_org};
2493
2494     my %buckets;
2495     my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2496     push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2497
2498     my @keys = sort { $a <=> $b } keys %buckets;
2499
2500
2501     if( $home_org ne $req_org ) {
2502       # -----------------------------------------------------------------------
2503       # shove the copies close to the request_lib into the primary buckets
2504       # directly before the farthest away copies.  That way, they are not
2505       # given priority, but they are checked before the farthest copies.
2506       # -----------------------------------------------------------------------
2507         $prox_cache{$req_org} =
2508             $e->search_actor_org_unit_proximity({from_org => $req_org})
2509             unless $prox_cache{$req_org};
2510         my $req_prox = $prox_cache{$req_org};
2511
2512         my %buckets2;
2513         my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2514         push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2515
2516         my $highest_key = $keys[@keys - 1];  # the farthest prox in the exising buckets
2517         my $new_key = $highest_key - 0.5; # right before the farthest prox
2518         my @keys2   = sort { $a <=> $b } keys %buckets2;
2519         for my $key (@keys2) {
2520             last if $key >= $highest_key;
2521             push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2522         }
2523     }
2524
2525     @keys = sort { $a <=> $b } keys %buckets;
2526
2527     my $title;
2528     my %seen;
2529     my @status;
2530     OUTER: for my $key (@keys) {
2531       my @cps = @{$buckets{$key}};
2532
2533       $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2534
2535       for my $copyid (@cps) {
2536
2537          next if $seen{$copyid};
2538          $seen{$copyid} = 1; # there could be dupes given the merged buckets
2539          my $copy = $e->retrieve_asset_copy($copyid);
2540          $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2541
2542          unless($title) { # grab the title if we don't already have it
2543             my $vol = $e->retrieve_asset_call_number(
2544                [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2545             $title = $vol->record;
2546          }
2547
2548          @status = verify_copy_for_hold(
2549             $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2550
2551          last OUTER if $status[0];
2552       }
2553     }
2554
2555     if (!$status[0]) {
2556         if (!defined($empty_ok)) {
2557             $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2558             $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2559         }
2560
2561         return (1,0) if ($empty_ok);
2562     }
2563     return @status;
2564 }
2565
2566 sub _check_monopart_hold_is_possible {
2567     my( $partid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2568
2569     my $e = new_editor();
2570     my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2571
2572     # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2573     my $copies = $e->json_query(
2574         {
2575             select => { acp => ['id', 'circ_lib'] },
2576               from => {
2577                 acp => {
2578                     acpm => {
2579                         field  => 'target_copy',
2580                         fkey   => 'id',
2581                         filter => { part => $partid }
2582                     },
2583                     acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2584                     ccs  => { field => 'id', filter => { holdable => 't'}, fkey => 'status'   }
2585                 }
2586             },
2587             where => {
2588                 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2589             },
2590             distinct => 1
2591         }
2592     );
2593
2594     $logger->info("monopart possible found ".scalar(@$copies)." potential copies");
2595
2596     my $empty_ok;
2597     if (!@$copies) {
2598         $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2599         $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2600
2601         return (
2602             0, 0, [
2603                 new OpenILS::Event(
2604                     "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2605                     "payload" => {"fail_part" => "no_ultimate_items"}
2606                 )
2607             ]
2608         ) unless $empty_ok;
2609
2610         return (1, 0);
2611     }
2612
2613     # -----------------------------------------------------------------------
2614     # sort the copies into buckets based on their circ_lib proximity to
2615     # the patron's home_ou.
2616     # -----------------------------------------------------------------------
2617
2618     my $home_org = $patron->home_ou;
2619     my $req_org = $request_lib->id;
2620
2621     $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2622
2623     $prox_cache{$home_org} =
2624         $e->search_actor_org_unit_proximity({from_org => $home_org})
2625         unless $prox_cache{$home_org};
2626     my $home_prox = $prox_cache{$home_org};
2627
2628     my %buckets;
2629     my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2630     push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2631
2632     my @keys = sort { $a <=> $b } keys %buckets;
2633
2634
2635     if( $home_org ne $req_org ) {
2636       # -----------------------------------------------------------------------
2637       # shove the copies close to the request_lib into the primary buckets
2638       # directly before the farthest away copies.  That way, they are not
2639       # given priority, but they are checked before the farthest copies.
2640       # -----------------------------------------------------------------------
2641         $prox_cache{$req_org} =
2642             $e->search_actor_org_unit_proximity({from_org => $req_org})
2643             unless $prox_cache{$req_org};
2644         my $req_prox = $prox_cache{$req_org};
2645
2646         my %buckets2;
2647         my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2648         push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2649
2650         my $highest_key = $keys[@keys - 1];  # the farthest prox in the exising buckets
2651         my $new_key = $highest_key - 0.5; # right before the farthest prox
2652         my @keys2   = sort { $a <=> $b } keys %buckets2;
2653         for my $key (@keys2) {
2654             last if $key >= $highest_key;
2655             push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2656         }
2657     }
2658
2659     @keys = sort { $a <=> $b } keys %buckets;
2660
2661     my $title;
2662     my %seen;
2663     my @status;
2664     OUTER: for my $key (@keys) {
2665       my @cps = @{$buckets{$key}};
2666
2667       $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2668
2669       for my $copyid (@cps) {
2670
2671          next if $seen{$copyid};
2672          $seen{$copyid} = 1; # there could be dupes given the merged buckets
2673          my $copy = $e->retrieve_asset_copy($copyid);
2674          $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2675
2676          unless($title) { # grab the title if we don't already have it
2677             my $vol = $e->retrieve_asset_call_number(
2678                [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2679             $title = $vol->record;
2680          }
2681
2682          @status = verify_copy_for_hold(
2683             $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2684
2685          last OUTER if $status[0];
2686       }
2687     }
2688
2689     if (!$status[0]) {
2690         if (!defined($empty_ok)) {
2691             $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2692             $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2693         }
2694
2695         return (1,0) if ($empty_ok);
2696     }
2697     return @status;
2698 }
2699
2700
2701 sub _check_volume_hold_is_possible {
2702         my( $vol, $title, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2703     my %org_filter = create_ranged_org_filter(new_editor(), $selection_ou, $depth);
2704         my $copies = new_editor->search_asset_copy({call_number => $vol->id, %org_filter});
2705         $logger->info("checking possibility of volume hold for volume ".$vol->id);
2706
2707     my $filter_copies = [];
2708     for my $copy (@$copies) {
2709         # ignore part-mapped copies for regular volume level holds
2710         push(@$filter_copies, $copy) unless
2711             new_editor->search_asset_copy_part_map({target_copy => $copy->id})->[0];
2712     }
2713     $copies = $filter_copies;
2714
2715     return (
2716         0, 0, [
2717             new OpenILS::Event(
2718                 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2719                 "payload" => {"fail_part" => "no_ultimate_items"}
2720             )
2721         ]
2722     ) unless @$copies;
2723
2724     my @status;
2725         for my $copy ( @$copies ) {
2726         @status = verify_copy_for_hold(
2727                         $patron, $requestor, $title, $copy, $pickup_lib, $request_lib );
2728         last if $status[0];
2729         }
2730         return @status;
2731 }
2732
2733
2734
2735 sub verify_copy_for_hold {
2736         my( $patron, $requestor, $title, $copy, $pickup_lib, $request_lib ) = @_;
2737         $logger->info("checking possibility of copy in hold request for copy ".$copy->id);
2738     my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2739                 {       patron                          => $patron,
2740                         requestor                       => $requestor,
2741                         copy                            => $copy,
2742                         title                           => $title,
2743                         title_descriptor        => $title->fixed_fields, # this is fleshed into the title object
2744                         pickup_lib                      => $pickup_lib,
2745                         request_lib                     => $request_lib,
2746             new_hold            => 1,
2747             show_event_list     => 1
2748                 }
2749         );
2750
2751     return (
2752         (not scalar @$permitted), # true if permitted is an empty arrayref
2753         (   # XXX This test is of very dubious value; someone should figure
2754             # out what if anything is checking this value
2755                 ($copy->circ_lib == $pickup_lib) and
2756             ($copy->status == OILS_COPY_STATUS_AVAILABLE)
2757         ),
2758         $permitted
2759     );
2760 }
2761
2762
2763
2764 sub find_nearest_permitted_hold {
2765
2766     my $class  = shift;
2767     my $editor = shift;     # CStoreEditor object
2768     my $copy   = shift;     # copy to target
2769     my $user   = shift;     # staff
2770     my $check_only = shift; # do no updates, just see if the copy could fulfill a hold
2771
2772     my $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND');
2773
2774     my $bc = $copy->barcode;
2775
2776         # find any existing holds that already target this copy
2777         my $old_holds = $editor->search_action_hold_request(
2778                 {       current_copy => $copy->id,
2779                         cancel_time  => undef,
2780                         capture_time => undef
2781                 }
2782         );
2783
2784         # hold->type "R" means we need this copy
2785         for my $h (@$old_holds) { return ($h) if $h->hold_type eq 'R'; }
2786
2787
2788     my $hold_stall_interval = $U->ou_ancestor_setting_value($user->ws_ou, OILS_SETTING_HOLD_SOFT_STALL);
2789
2790         $logger->info("circulator: searching for best hold at org ".$user->ws_ou.
2791         " and copy $bc with a hold stalling interval of ". ($hold_stall_interval || "(none)"));
2792
2793         my $fifo = $U->ou_ancestor_setting_value($user->ws_ou, 'circ.holds_fifo');
2794
2795         # search for what should be the best holds for this copy to fulfill
2796         my $best_holds = $U->storagereq(
2797         "open-ils.storage.action.hold_request.nearest_hold.atomic",
2798                 $user->ws_ou, $copy->id, 10, $hold_stall_interval, $fifo );
2799
2800         unless(@$best_holds) {
2801
2802                 if( my $hold = $$old_holds[0] ) {
2803                         $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
2804                         return ($hold);
2805                 }
2806
2807                 $logger->info("circulator: no suitable holds found for copy $bc");
2808                 return (undef, $evt);
2809         }
2810
2811
2812         my $best_hold;
2813
2814         # for each potential hold, we have to run the permit script
2815         # to make sure the hold is actually permitted.
2816     my %reqr_cache;
2817     my %org_cache;
2818         for my $holdid (@$best_holds) {
2819                 next unless $holdid;
2820                 $logger->info("circulator: checking if hold $holdid is permitted for copy $bc");
2821
2822                 my $hold = $editor->retrieve_action_hold_request($holdid) or next;
2823                 my $reqr = $reqr_cache{$hold->requestor} || $editor->retrieve_actor_user($hold->requestor);
2824                 my $rlib = $org_cache{$hold->request_lib} || $editor->retrieve_actor_org_unit($hold->request_lib);
2825
2826                 $reqr_cache{$hold->requestor} = $reqr;
2827                 $org_cache{$hold->request_lib} = $rlib;
2828
2829                 # see if this hold is permitted
2830                 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2831                         {       patron_id                       => $hold->usr,
2832                                 requestor                       => $reqr,
2833                                 copy                            => $copy,
2834                                 pickup_lib                      => $hold->pickup_lib,
2835                                 request_lib                     => $rlib,
2836                                 retarget                        => 1
2837                         }
2838                 );
2839
2840                 if( $permitted ) {
2841                         $best_hold = $hold;
2842                         last;
2843                 }
2844         }
2845
2846
2847         unless( $best_hold ) { # no "good" permitted holds were found
2848                 if( my $hold = $$old_holds[0] ) { # can we return a pre-targeted hold?
2849                         $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
2850                         return ($hold);
2851                 }
2852
2853                 # we got nuthin
2854                 $logger->info("circulator: no suitable holds found for copy $bc");
2855                 return (undef, $evt);
2856         }
2857
2858         $logger->info("circulator: best hold ".$best_hold->id." found for copy $bc");
2859
2860         # indicate a permitted hold was found
2861         return $best_hold if $check_only;
2862
2863         # we've found a permitted hold.  we need to "grab" the copy
2864         # to prevent re-targeted holds (next part) from re-grabbing the copy
2865         $best_hold->current_copy($copy->id);
2866         $editor->update_action_hold_request($best_hold)
2867                 or return (undef, $editor->event);
2868
2869
2870     my @retarget;
2871
2872         # re-target any other holds that already target this copy
2873         for my $old_hold (@$old_holds) {
2874                 next if $old_hold->id eq $best_hold->id; # don't re-target the hold we want
2875                 $logger->info("circulator: clearing current_copy and prev_check_time on hold ".
2876             $old_hold->id." after a better hold [".$best_hold->id."] was found");
2877         $old_hold->clear_current_copy;
2878         $old_hold->clear_prev_check_time;
2879         $editor->update_action_hold_request($old_hold)
2880             or return (undef, $editor->event);
2881         push(@retarget, $old_hold->id);
2882         }
2883
2884         return ($best_hold, undef, (@retarget) ? \@retarget : undef);
2885 }
2886
2887
2888
2889
2890
2891
2892 __PACKAGE__->register_method(
2893     method   => 'all_rec_holds',
2894     api_name => 'open-ils.circ.holds.retrieve_all_from_title',
2895 );
2896
2897 sub all_rec_holds {
2898         my( $self, $conn, $auth, $title_id, $args ) = @_;
2899
2900         my $e = new_editor(authtoken=>$auth);
2901         $e->checkauth or return $e->event;
2902         $e->allowed('VIEW_HOLD') or return $e->event;
2903
2904         $args ||= {};
2905     $args->{fulfillment_time} = undef; #  we don't want to see old fulfilled holds
2906         $args->{cancel_time} = undef;
2907
2908         my $resp = { volume_holds => [], copy_holds => [], recall_holds => [], force_holds => [], metarecord_holds => [], part_holds => [], issuance_holds => [] };
2909
2910     my $mr_map = $e->search_metabib_metarecord_source_map({source => $title_id})->[0];
2911     if($mr_map) {
2912         $resp->{metarecord_holds} = $e->search_action_hold_request(
2913             {   hold_type => OILS_HOLD_TYPE_METARECORD,
2914                 target => $mr_map->metarecord,
2915                 %$args
2916             }, {idlist => 1}
2917         );
2918     }
2919
2920         $resp->{title_holds} = $e->search_action_hold_request(
2921                 {
2922                         hold_type => OILS_HOLD_TYPE_TITLE,
2923                         target => $title_id,
2924                         %$args
2925                 }, {idlist=>1} );
2926
2927     my $parts = $e->search_biblio_monograph_part(
2928         {
2929             record => $title_id
2930         }, {idlist=>1} );
2931
2932     if (@$parts) {
2933         $resp->{part_holds} = $e->search_action_hold_request(
2934             {
2935                 hold_type => OILS_HOLD_TYPE_MONOPART,
2936                 target => $parts,
2937                 %$args
2938             }, {idlist=>1} );
2939     }
2940
2941     my $subs = $e->search_serial_subscription(
2942         { record_entry => $title_id }, {idlist=>1});
2943
2944     if (@$subs) {
2945         my $issuances = $e->search_serial_issuance(
2946             {subscription => $subs}, {idlist=>1}
2947         );
2948
2949         if ($issuances) {
2950             $resp->{issuance_holds} = $e->search_action_hold_request(
2951                 {
2952                     hold_type => OILS_HOLD_TYPE_ISSUANCE,
2953                     target => $issuances,
2954                     %$args
2955                 }, {idlist=>1}
2956             );
2957         }
2958     }
2959
2960         my $vols = $e->search_asset_call_number(
2961                 { record => $title_id, deleted => 'f' }, {idlist=>1});
2962
2963         return $resp unless @$vols;
2964
2965         $resp->{volume_holds} = $e->search_action_hold_request(
2966                 {
2967                         hold_type => OILS_HOLD_TYPE_VOLUME,
2968                         target => $vols,
2969                         %$args },
2970                 {idlist=>1} );
2971
2972         my $copies = $e->search_asset_copy(
2973                 { call_number => $vols, deleted => 'f' }, {idlist=>1});
2974
2975         return $resp unless @$copies;
2976
2977         $resp->{copy_holds} = $e->search_action_hold_request(
2978                 {
2979                         hold_type => OILS_HOLD_TYPE_COPY,
2980                         target => $copies,
2981                         %$args },
2982                 {idlist=>1} );
2983
2984         $resp->{recall_holds} = $e->search_action_hold_request(
2985                 {
2986                         hold_type => OILS_HOLD_TYPE_RECALL,
2987                         target => $copies,
2988                         %$args },
2989                 {idlist=>1} );
2990
2991         $resp->{force_holds} = $e->search_action_hold_request(
2992                 {
2993                         hold_type => OILS_HOLD_TYPE_FORCE,
2994                         target => $copies,
2995                         %$args },
2996                 {idlist=>1} );
2997
2998         return $resp;
2999 }
3000
3001
3002
3003
3004
3005 __PACKAGE__->register_method(
3006     method        => 'uber_hold',
3007     authoritative => 1,
3008     api_name      => 'open-ils.circ.hold.details.retrieve'
3009 );
3010
3011 sub uber_hold {
3012         my($self, $client, $auth, $hold_id, $args) = @_;
3013         my $e = new_editor(authtoken=>$auth);
3014         $e->checkauth or return $e->event;
3015     return uber_hold_impl($e, $hold_id, $args);
3016 }
3017
3018 __PACKAGE__->register_method(
3019     method        => 'batch_uber_hold',
3020     authoritative => 1,
3021     stream        => 1,
3022     api_name      => 'open-ils.circ.hold.details.batch.retrieve'
3023 );
3024
3025 sub batch_uber_hold {
3026         my($self, $client, $auth, $hold_ids, $args) = @_;
3027         my $e = new_editor(authtoken=>$auth);
3028         $e->checkauth or return $e->event;
3029     $client->respond(uber_hold_impl($e, $_, $args)) for @$hold_ids;
3030     return undef;
3031 }
3032
3033 sub uber_hold_impl {
3034     my($e, $hold_id, $args) = @_;
3035     $args ||= {};
3036
3037         my $hold = $e->retrieve_action_hold_request(
3038                 [
3039                         $hold_id,
3040                         {
3041                                 flesh => 1,
3042                                 flesh_fields => { ahr => [ 'current_copy', 'usr', 'notes' ] }
3043                         }
3044                 ]
3045         ) or return $e->event;
3046
3047     if($hold->usr->id ne $e->requestor->id) {
3048         # A user is allowed to see his/her own holds
3049             $e->allowed('VIEW_HOLD') or return $e->event;
3050         $hold->notes( # filter out any non-staff ("private") notes
3051             [ grep { !$U->is_true($_->staff) } @{$hold->notes} ] );
3052
3053     } else {
3054         # caller is asking for own hold, but may not have permission to view staff notes
3055             unless($e->allowed('VIEW_HOLD')) {
3056             $hold->notes( # filter out any staff notes
3057                 [ grep { $U->is_true($_->staff) } @{$hold->notes} ] );
3058         }
3059     }
3060
3061         my $user = $hold->usr;
3062         $hold->usr($user->id);
3063
3064
3065         my( $mvr, $volume, $copy, $issuance, $part, $bre ) = find_hold_mvr($e, $hold, $args->{suppress_mvr});
3066
3067         flesh_hold_notices([$hold], $e) unless $args->{suppress_notices};
3068         flesh_hold_transits([$hold]) unless $args->{suppress_transits};
3069
3070     my $details = retrieve_hold_queue_status_impl($e, $hold);
3071
3072     my $resp = {
3073         hold    => $hold,
3074         bre_id  => $bre->id,
3075         ($copy     ? (copy           => $copy)     : ()),
3076         ($volume   ? (volume         => $volume)   : ()),
3077         ($issuance ? (issuance       => $issuance) : ()),
3078         ($part     ? (part           => $part)     : ()),
3079         ($args->{include_bre}  ?  (bre => $bre)    : ()),
3080         ($args->{suppress_mvr} ?  () : (mvr => $mvr)),
3081         %$details
3082     };
3083
3084     unless($args->{suppress_patron_details}) {
3085             my $card = $e->retrieve_actor_card($user->card) or return $e->event;
3086         $resp->{patron_first}   = $user->first_given_name,
3087         $resp->{patron_last}    = $user->family_name,
3088         $resp->{patron_barcode} = $card->barcode,
3089         $resp->{patron_alias}   = $user->alias,
3090     };
3091
3092     return $resp;
3093 }
3094
3095
3096
3097 # -----------------------------------------------------
3098 # Returns the MVR object that represents what the
3099 # hold is all about
3100 # -----------------------------------------------------
3101 sub find_hold_mvr {
3102         my( $e, $hold, $no_mvr ) = @_;
3103
3104         my $tid;
3105         my $copy;
3106         my $volume;
3107     my $issuance;
3108     my $part;
3109
3110         if( $hold->hold_type eq OILS_HOLD_TYPE_METARECORD ) {
3111                 my $mr = $e->retrieve_metabib_metarecord($hold->target)
3112                         or return $e->event;
3113                 $tid = $mr->master_record;
3114
3115         } elsif( $hold->hold_type eq OILS_HOLD_TYPE_TITLE ) {
3116                 $tid = $hold->target;
3117
3118         } elsif( $hold->hold_type eq OILS_HOLD_TYPE_VOLUME ) {
3119                 $volume = $e->retrieve_asset_call_number($hold->target)
3120                         or return $e->event;
3121                 $tid = $volume->record;
3122
3123     } elsif( $hold->hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
3124         $issuance = $e->retrieve_serial_issuance([
3125             $hold->target,
3126             {flesh => 1, flesh_fields => {siss => [ qw/subscription/ ]}}
3127         ]) or return $e->event;
3128
3129         $tid = $issuance->subscription->record_entry;
3130
3131     } elsif( $hold->hold_type eq OILS_HOLD_TYPE_MONOPART ) {
3132         $part = $e->retrieve_biblio_monograph_part([
3133             $hold->target
3134         ]) or return $e->event;
3135
3136         $tid = $part->record;
3137
3138         } elsif( $hold->hold_type eq OILS_HOLD_TYPE_COPY || $hold->hold_type eq OILS_HOLD_TYPE_RECALL || $hold->hold_type eq OILS_HOLD_TYPE_FORCE ) {
3139                 $copy = $e->retrieve_asset_copy([
3140             $hold->target,
3141             {flesh => 1, flesh_fields => {acp => ['call_number']}}
3142         ]) or return $e->event;
3143
3144                 $volume = $copy->call_number;
3145                 $tid = $volume->record;
3146         }
3147
3148         if(!$copy and ref $hold->current_copy ) {
3149                 $copy = $hold->current_copy;
3150                 $hold->current_copy($copy->id);
3151         }
3152
3153         if(!$volume and $copy) {
3154                 $volume = $e->retrieve_asset_call_number($copy->call_number);
3155         }
3156
3157     # TODO return metarcord mvr for M holds
3158         my $title = $e->retrieve_biblio_record_entry($tid);
3159         return ( ($no_mvr) ? undef : $U->record_to_mvr($title), $volume, $copy, $issuance, $part, $title );
3160 }
3161
3162 __PACKAGE__->register_method(
3163     method    => 'clear_shelf_cache',
3164     api_name  => 'open-ils.circ.hold.clear_shelf.get_cache',
3165     stream    => 1,
3166     signature => {
3167         desc => q/
3168             Returns the holds processed with the given cache key
3169         /
3170     }
3171 );
3172
3173 sub clear_shelf_cache {
3174     my($self, $client, $auth, $cache_key, $chunk_size) = @_;
3175     my $e = new_editor(authtoken => $auth, xact => 1);
3176     return $e->die_event unless $e->checkauth and $e->allowed('VIEW_HOLD');
3177
3178     $chunk_size ||= 25;
3179     my $hold_data = OpenSRF::Utils::Cache->new('global')->get_cache($cache_key);
3180
3181     if (!$hold_data) {
3182         $logger->info("no hold data found in cache"); # XXX TODO return event
3183         $e->rollback;
3184         return undef;
3185     }
3186
3187     my $maximum = 0;
3188     foreach (keys %$hold_data) {
3189         $maximum += scalar(@{ $hold_data->{$_} });
3190     }
3191     $client->respond({"maximum" => $maximum, "progress" => 0});
3192
3193     for my $action (sort keys %$hold_data) {
3194         while (@{$hold_data->{$action}}) {
3195             my @hid_chunk = splice @{$hold_data->{$action}}, 0, $chunk_size;
3196
3197             my $result_chunk = $e->json_query({
3198                 "select" => {
3199                     "acp" => ["barcode"],
3200                     "au" => [qw/
3201                         first_given_name second_given_name family_name alias
3202                     /],
3203                     "acn" => ["label"],
3204                     "acnp" => [{column => "label", alias => "prefix"}],
3205                     "acns" => [{column => "label", alias => "suffix"}],
3206                     "bre" => ["marc"],
3207                     "acpl" => ["name"],
3208                     "ahr" => ["id"]
3209                 },
3210                 "from" => {
3211                     "ahr" => {
3212                         "acp" => {
3213                             "field" => "id", "fkey" => "current_copy",
3214                             "join" => {
3215                                 "acn" => {
3216                                     "field" => "id", "fkey" => "call_number",
3217                                     "join" => {
3218                                         "bre" => {
3219                                             "field" => "id", "fkey" => "record"
3220                                         },
3221                                         "acnp" => {
3222                                             "field" => "id", "fkey" => "prefix"
3223                                         },
3224                                         "acns" => {
3225                                             "field" => "id", "fkey" => "suffix"
3226                                         }
3227                                     }
3228                                 },
3229                                 "acpl" => {"field" => "id", "fkey" => "location"}
3230                             }
3231                         },
3232                         "au" => {"field" => "id", "fkey" => "usr"}
3233                     }
3234                 },
3235                 "where" => {"+ahr" => {"id" => \@hid_chunk}}
3236             }, {"substream" => 1}) or return $e->die_event;
3237
3238             $client->respond([
3239                 map {
3240                     +{"action" => $action, "hold_details" => $_}
3241                 } @$result_chunk
3242             ]);
3243         }
3244     }
3245
3246     $e->rollback;
3247     return undef;
3248 }
3249
3250
3251 __PACKAGE__->register_method(
3252     method    => 'clear_shelf_process',
3253     stream    => 1,
3254     api_name  => 'open-ils.circ.hold.clear_shelf.process',
3255     signature => {
3256         desc => q/
3257             1. Find all holds that have expired on the holds shelf
3258             2. Cancel the holds
3259             3. If a clear-shelf status is configured, put targeted copies into this status
3260             4. Divide copies into 3 groups: items to transit, items to reshelve, and items
3261                 that are needed for holds.  No subsequent action is taken on the holds
3262                 or items after grouping.
3263         /
3264     }
3265 );
3266
3267 sub clear_shelf_process {
3268         my($self, $client, $auth, $org_id, $match_copy) = @_;
3269
3270     my $current_copy = { '!=' => undef };
3271     $current_copy = { '=' => $match_copy } if $match_copy;
3272
3273         my $e = new_editor(authtoken=>$auth, xact => 1);
3274         $e->checkauth or return $e->die_event;
3275         my $cache = OpenSRF::Utils::Cache->new('global');
3276
3277     $org_id ||= $e->requestor->ws_ou;
3278         $e->allowed('UPDATE_HOLD', $org_id) or return $e->die_event;
3279
3280     my $copy_status = $U->ou_ancestor_setting_value($org_id, 'circ.holds.clear_shelf.copy_status');
3281
3282     # Find holds on the shelf that have been there too long
3283     my $hold_ids = $e->search_action_hold_request(
3284         {   shelf_expire_time => {'<' => 'now'},
3285             pickup_lib        => $org_id,
3286             cancel_time       => undef,
3287             fulfillment_time  => undef,
3288             shelf_time        => {'!=' => undef},
3289             capture_time      => {'!=' => undef},
3290             current_copy      => $current_copy,
3291         },
3292         { idlist => 1 }
3293     );
3294
3295     my @holds;
3296     my $chunk_size = 25; # chunked status updates
3297     my $counter = 0;
3298     for my $hold_id (@$hold_ids) {
3299
3300         $logger->info("Clear shelf processing hold $hold_id");
3301
3302         my $hold = $e->retrieve_action_hold_request([
3303             $hold_id, {
3304                 flesh => 1,
3305                 flesh_fields => {ahr => ['current_copy']}
3306             }
3307         ]);
3308
3309         $hold->cancel_time('now');
3310         $hold->cancel_cause(2); # Hold Shelf expiration
3311         $e->update_action_hold_request($hold) or return $e->die_event;
3312         delete_hold_copy_maps($self, $e, $hold->id) and return $e->die_event;
3313
3314         my $copy = $hold->current_copy;
3315
3316         if($copy_status or $copy_status == 0) {
3317             # if a clear-shelf copy status is defined, update the copy
3318             $copy->status($copy_status);
3319             $copy->edit_date('now');
3320             $copy->editor($e->requestor->id);
3321             $e->update_asset_copy($copy) or return $e->die_event;
3322         }
3323
3324         push(@holds, $hold);
3325         $client->respond({maximum => scalar(@holds), progress => $counter}) if ( (++$counter % $chunk_size) == 0);
3326     }
3327
3328     if ($e->commit) {
3329
3330         my %cache_data = (
3331             hold => [],
3332             transit => [],
3333             shelf => []
3334         );
3335
3336         for my $hold (@holds) {
3337
3338             my $copy = $hold->current_copy;
3339             my ($alt_hold) = __PACKAGE__->find_nearest_permitted_hold($e, $copy, $e->requestor, 1);
3340
3341             if($alt_hold and !$match_copy) {
3342
3343                 push(@{$cache_data{hold}}, $hold->id); # copy is needed for a hold
3344
3345             } elsif($copy->circ_lib != $e->requestor->ws_ou) {
3346
3347                 push(@{$cache_data{transit}}, $hold->id); # copy needs to transit
3348
3349             } else {
3350
3351                 push(@{$cache_data{shelf}}, $hold->id); # copy needs to go back to the shelf
3352             }
3353         }
3354
3355         my $cache_key = md5_hex(time . $$ . rand());
3356         $logger->info("clear_shelf_cache: storing under $cache_key");
3357         $cache->put_cache($cache_key, \%cache_data, 7200); # TODO: 2 hours.  configurable?
3358
3359         # tell the client we're done
3360         $client->respond_complete({cache_key => $cache_key});
3361
3362         # ------------
3363         # fire off the hold cancelation trigger and wait for response so don't flood the service
3364
3365         # refetch the holds to pick up the caclulated cancel_time,
3366         # which may be needed by Action/Trigger
3367         $e->xact_begin;
3368         my $updated_holds = $e->search_action_hold_request({id => $hold_ids}, {substream => 1});
3369         $e->rollback;
3370
3371         $U->create_events_for_hook(
3372             'hold_request.cancel.expire_holds_shelf',
3373             $_, $org_id, undef, undef, 1) for @$updated_holds;
3374
3375     } else {
3376         # tell the client we're done
3377         $client->respond_complete;
3378     }
3379 }
3380
3381 __PACKAGE__->register_method(
3382     method    => 'usr_hold_summary',
3383     api_name  => 'open-ils.circ.holds.user_summary',
3384     signature => q/
3385         Returns a summary of holds statuses for a given user
3386     /
3387 );
3388
3389 sub usr_hold_summary {
3390     my($self, $conn, $auth, $user_id) = @_;
3391
3392         my $e = new_editor(authtoken=>$auth);
3393         $e->checkauth or return $e->event;
3394         $e->allowed('VIEW_HOLD') or return $e->event;
3395
3396     my $holds = $e->search_action_hold_request(
3397         {
3398             usr =>  $user_id ,
3399             fulfillment_time => undef,
3400             cancel_time      => undef,
3401         }
3402     );
3403
3404     my %summary = (1 => 0, 2 => 0, 3 => 0, 4 => 0);
3405     $summary{_hold_status($e, $_)} += 1 for @$holds;
3406     return \%summary;
3407 }
3408
3409
3410
3411 __PACKAGE__->register_method(
3412     method    => 'hold_has_copy_at',
3413     api_name  => 'open-ils.circ.hold.has_copy_at',
3414     signature => {
3415         desc   =>
3416                 'Returns the ID of the found copy and name of the shelving location if there is ' .
3417                 'an available copy at the specified org unit.  Returns empty hash otherwise.  '   .
3418                 'The anticipated use for this method is to determine whether an item is '         .
3419                 'available at the library where the user is placing the hold (or, alternatively, '.
3420                 'at the pickup library) to encourage bypassing the hold placement and just '      .
3421                 'checking out the item.' ,
3422         params => [
3423             { desc => 'Authentication Token', type => 'string' },
3424             { desc => 'Method Arguments.  Options include: hold_type, hold_target, org_unit.  '
3425                     . 'hold_type is the hold type code (T, V, C, M, ...).  '
3426                     . 'hold_target is the identifier of the hold target object.  '
3427                     . 'org_unit is org unit ID.',
3428               type => 'object'
3429             }
3430         ],
3431         return => {
3432             desc => q/Result hash like { "copy" : copy_id, "location" : location_name }, empty hash on misses, event on error./,
3433             type => 'object'
3434         }
3435     }
3436 );
3437
3438 sub hold_has_copy_at {
3439     my($self, $conn, $auth, $args) = @_;
3440
3441         my $e = new_editor(authtoken=>$auth);
3442         $e->checkauth or return $e->event;
3443
3444     my $hold_type   = $$args{hold_type};
3445     my $hold_target = $$args{hold_target};
3446     my $org_unit    = $$args{org_unit};
3447
3448     my $query = {
3449         select => {acp => ['id'], acpl => ['name']},
3450         from   => {
3451             acp => {
3452                 acpl => {field => 'id', filter => { holdable => 't'}, fkey => 'location'},
3453                 ccs  => {field => 'id', filter => { holdable => 't'}, fkey => 'status'  }
3454             }
3455         },
3456         where => {'+acp' => { circulate => 't', deleted => 'f', holdable => 't', circ_lib => $org_unit}},
3457         limit => 1
3458     };
3459
3460     if($hold_type eq 'C') {
3461
3462         $query->{where}->{'+acp'}->{id} = $hold_target;
3463
3464     } elsif($hold_type eq 'V') {
3465
3466         $query->{where}->{'+acp'}->{call_number} = $hold_target;
3467
3468     } elsif($hold_type eq 'T') {
3469
3470         $query->{from}->{acp}->{acn} = {
3471             field  => 'id',
3472             fkey   => 'call_number',
3473             'join' => {
3474                 bre => {
3475                     field  => 'id',
3476                     filter => {id => $hold_target},
3477                     fkey   => 'record'
3478                 }
3479             }
3480         };
3481
3482     } else {
3483
3484         $query->{from}->{acp}->{acn} = {
3485             field => 'id',
3486             fkey  => 'call_number',
3487             join  => {
3488                 bre => {
3489                     field => 'id',
3490                     fkey  => 'record',
3491                     join  => {
3492                         mmrsm => {
3493                             field  => 'source',
3494                             fkey   => 'id',
3495                             filter => {metarecord => $hold_target},
3496                         }
3497                     }
3498                 }
3499             }
3500         };
3501     }
3502
3503     my $res = $e->json_query($query)->[0] or return {};
3504     return {copy => $res->{id}, location => $res->{name}} if $res;
3505 }
3506
3507
3508 # returns true if the user already has an item checked out
3509 # that could be used to fulfill the requested hold.
3510 sub hold_item_is_checked_out {
3511     my($e, $user_id, $hold_type, $hold_target) = @_;
3512
3513     my $query = {
3514         select => {acp => ['id']},
3515         from   => {acp => {}},
3516         where  => {
3517             '+acp' => {
3518                 id => {
3519                     in => { # copies for circs the user has checked out
3520                         select => {circ => ['target_copy']},
3521                         from   => 'circ',
3522                         where  => {
3523                             usr => $user_id,
3524                             checkin_time => undef,
3525                             '-or' => [
3526                                 {stop_fines => ["MAXFINES","LONGOVERDUE"]},
3527                                 {stop_fines => undef}
3528                             ],
3529                         }
3530                     }
3531                 }
3532             }
3533         },
3534         limit => 1
3535     };
3536
3537     if($hold_type eq 'C' || $hold_type eq 'R' || $hold_type eq 'F') {
3538
3539         $query->{where}->{'+acp'}->{id}->{in}->{where}->{'target_copy'} = $hold_target;
3540
3541     } elsif($hold_type eq 'V') {
3542
3543         $query->{where}->{'+acp'}->{call_number} = $hold_target;
3544
3545      } elsif($hold_type eq 'P') {
3546
3547         $query->{from}->{acp}->{acpm} = {
3548             field  => 'target_copy',
3549             fkey   => 'id',
3550             filter => {part => $hold_target},
3551         };
3552
3553      } elsif($hold_type eq 'I') {
3554
3555         $query->{from}->{acp}->{sitem} = {
3556             field  => 'unit',
3557             fkey   => 'id',
3558             filter => {issuance => $hold_target},
3559         };
3560
3561     } elsif($hold_type eq 'T') {
3562
3563         $query->{from}->{acp}->{acn} = {
3564             field  => 'id',
3565             fkey   => 'call_number',
3566             'join' => {
3567                 bre => {
3568                     field  => 'id',
3569                     filter => {id => $hold_target},
3570                     fkey   => 'record'
3571                 }
3572             }
3573         };
3574
3575     } else {
3576
3577         $query->{from}->{acp}->{acn} = {
3578             field => 'id',
3579             fkey => 'call_number',
3580             join => {
3581                 bre => {
3582                     field => 'id',
3583                     fkey => 'record',
3584                     join => {
3585                         mmrsm => {
3586                             field => 'source',
3587                             fkey => 'id',
3588                             filter => {metarecord => $hold_target},
3589                         }
3590                     }
3591                 }
3592             }
3593         };
3594     }
3595
3596     return $e->json_query($query)->[0];
3597 }
3598
3599 __PACKAGE__->register_method(
3600     method    => 'change_hold_title',
3601     api_name  => 'open-ils.circ.hold.change_title',
3602     signature => {
3603         desc => q/
3604             Updates all title level holds targeting the specified bibs to point a new bib./,
3605         params => [
3606             { desc => 'Authentication Token', type => 'string' },
3607             { desc => 'New Target Bib Id',    type => 'number' },
3608             { desc => 'Old Target Bib Ids',   type => 'array'  },
3609         ],
3610         return => { desc => '1 on success' }
3611     }
3612 );
3613
3614 __PACKAGE__->register_method(
3615     method    => 'change_hold_title_for_specific_holds',
3616     api_name  => 'open-ils.circ.hold.change_title.specific_holds',
3617     signature => {
3618         desc => q/
3619             Updates specified holds to target new bib./,
3620         params => [
3621             { desc => 'Authentication Token', type => 'string' },
3622             { desc => 'New Target Bib Id',    type => 'number' },
3623             { desc => 'Holds Ids for holds to update',   type => 'array'  },
3624         ],
3625         return => { desc => '1 on success' }
3626     }
3627 );
3628
3629
3630 sub change_hold_title {
3631     my( $self, $client, $auth, $new_bib_id, $bib_ids ) = @_;
3632
3633     my $e = new_editor(authtoken=>$auth, xact=>1);
3634     return $e->die_event unless $e->checkauth;
3635
3636     my $holds = $e->search_action_hold_request(
3637         [
3638             {
3639                 cancel_time      => undef,
3640                 fulfillment_time => undef,
3641                 hold_type        => 'T',
3642                 target           => $bib_ids
3643             },
3644             {
3645                 flesh        => 1,
3646                 flesh_fields => { ahr => ['usr'] }
3647             }
3648         ],
3649         { substream => 1 }
3650     );
3651
3652     for my $hold (@$holds) {
3653         $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
3654         $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
3655         $hold->target( $new_bib_id );
3656         $e->update_action_hold_request($hold) or return $e->die_event;
3657     }
3658
3659     $e->commit;
3660
3661     _reset_hold($self, $e->requestor, $_) for @$holds;
3662
3663     return 1;
3664 }
3665
3666 sub change_hold_title_for_specific_holds {
3667     my( $self, $client, $auth, $new_bib_id, $hold_ids ) = @_;
3668
3669     my $e = new_editor(authtoken=>$auth, xact=>1);
3670     return $e->die_event unless $e->checkauth;
3671
3672     my $holds = $e->search_action_hold_request(
3673         [
3674             {
3675                 cancel_time      => undef,
3676                 fulfillment_time => undef,
3677                 hold_type        => 'T',
3678                 id               => $hold_ids
3679             },
3680             {
3681                 flesh        => 1,
3682                 flesh_fields => { ahr => ['usr'] }
3683             }
3684         ],
3685         { substream => 1 }
3686     );
3687
3688     for my $hold (@$holds) {
3689         $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
3690         $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
3691         $hold->target( $new_bib_id );
3692         $e->update_action_hold_request($hold) or return $e->die_event;
3693     }
3694
3695     $e->commit;
3696
3697     _reset_hold($self, $e->requestor, $_) for @$holds;
3698
3699     return 1;
3700 }
3701
3702 __PACKAGE__->register_method(
3703     method    => 'rec_hold_count',
3704     api_name  => 'open-ils.circ.bre.holds.count',
3705     signature => {
3706         desc => q/Returns the total number of holds that target the
3707             selected bib record or its associated copies and call_numbers/,
3708         params => [
3709             { desc => 'Bib ID', type => 'number' },
3710         ],
3711         return => {desc => 'Hold count', type => 'number'}
3712     }
3713 );
3714
3715 __PACKAGE__->register_method(
3716     method    => 'rec_hold_count',
3717     api_name  => 'open-ils.circ.mmr.holds.count',
3718     signature => {
3719         desc => q/Returns the total number of holds that target the
3720             selected metarecord or its associated copies, call_numbers, and bib records/,
3721         params => [
3722             { desc => 'Metarecord ID', type => 'number' },
3723         ],
3724         return => {desc => 'Hold count', type => 'number'}
3725     }
3726 );
3727
3728 # XXX Need to add type I (and, soon, type P) holds to these counts
3729 sub rec_hold_count {
3730     my($self, $conn, $target_id) = @_;
3731
3732
3733     my $mmr_join = {
3734         mmrsm => {
3735             field => 'id',
3736             fkey => 'source',
3737             filter => {metarecord => $target_id}
3738         }
3739     };
3740
3741     my $bre_join = {
3742         bre => {
3743             field => 'id',
3744             filter => { id => $target_id },
3745             fkey => 'record'
3746         }
3747     };
3748
3749     if($self->api_name =~ /mmr/) {
3750         delete $bre_join->{bre}->{filter};
3751         $bre_join->{bre}->{join} = $mmr_join;
3752     }
3753
3754     my $cn_join = {
3755         acn => {
3756             field => 'id',
3757             fkey => 'call_number',
3758             join => $bre_join
3759         }
3760     };
3761
3762     my $query = {
3763         select => {ahr => [{column => 'id', transform => 'count', alias => 'count'}]},
3764         from => 'ahr',
3765         where => {
3766             '+ahr' => {
3767                 cancel_time => undef,
3768                 fulfillment_time => undef,
3769                 '-or' => [
3770                     {
3771                         '-and' => {
3772                             hold_type => [qw/C F R/],
3773                             target => {
3774                                 in => {
3775                                     select => {acp => ['id']},
3776                                     from => { acp => $cn_join }
3777                                 }
3778                             }
3779                         }
3780                     },
3781                     {
3782                         '-and' => {
3783                             hold_type => 'V',
3784                             target => {
3785                                 in => {
3786                                     select => {acn => ['id']},
3787                                     from => {acn => $bre_join}
3788                                 }
3789                             }
3790                         }
3791                     },
3792                     {
3793                         '-and' => {
3794                             hold_type => 'T',
3795                             target => $target_id
3796                         }
3797                     }
3798                 ]
3799             }
3800         }
3801     };
3802
3803     if($self->api_name =~ /mmr/) {
3804         $query->{where}->{'+ahr'}->{'-or'}->[2] = {
3805             '-and' => {
3806                 hold_type => 'T',
3807                 target => {
3808                     in => {
3809                         select => {bre => ['id']},
3810                         from => {bre => $mmr_join}
3811                     }
3812                 }
3813             }
3814         };
3815
3816         $query->{where}->{'+ahr'}->{'-or'}->[3] = {
3817             '-and' => {
3818                 hold_type => 'M',
3819                 target => $target_id
3820             }
3821         };
3822     }
3823
3824
3825     return new_editor()->json_query($query)->[0]->{count};
3826 }
3827
3828
3829
3830
3831
3832
3833 1;