Open-ILS/src/perlmods/OpenILS/Application/Storage/Publisher/action.pm

   1 package OpenILS::Application::Storage::Publisher::action;
   2 use base qw/OpenILS::Application::Storage::Publisher/;
   3 use OpenSRF::Utils::Logger qw/:level/;
   4 use OpenSRF::Utils qw/:datetime/;
   5 use OpenSRF::AppSession;
   6 use OpenSRF::EX qw/:try/;
   7 use OpenILS::Utils::Fieldmapper;
   8 use OpenILS::Utils::PermitHold;
   9 use DateTime;
  10 use DateTime::Format::ISO8601;
  11
  12
  13 my $parser = DateTime::Format::ISO8601->new;
  14 my $log = 'OpenSRF::Utils::Logger';
  15
  16 sub open_noncat_circs {
  17         my $self = shift;
  18         my $client = shift;
  19         my $user = shift;
  20
  21         my $a = action::non_cataloged_circulation->table;
  22         my $c = config::non_cataloged_type->table;
  23
  24         my $sql = <<"   SQL";
  25                 SELECT  a.id
  26                   FROM  $a a
  27                         JOIN $c c ON (a.item_type = c.id)
  28                   WHERE a.circ_time + c.circ_duration > current_timestamp
  29                         AND a.patron = ?
  30         SQL
  31
  32         return action::non_cataloged_circulation->db_Main->selectcol_arrayref($sql, {}, $user);
  33 }
  34 __PACKAGE__->register_method(
  35         api_name        => 'open-ils.storage.action.open_non_cataloged_circulation.user',
  36         api_level       => 1,
  37         argc            => 1,
  38         method          => 'open_noncat_circs',
  39 );
  40
  41
  42 sub ou_hold_requests {
  43         my $self = shift;
  44         my $client = shift;
  45         my $ou = shift;
  46
  47         my $h_table = action::hold_request->table;
  48         my $c_table = asset::copy->table;
  49         my $o_table = actor::org_unit->table;
  50
  51         my $SQL = <<"   SQL";
  52                 SELECT  h.id
  53                   FROM  $h_table h
  54                         JOIN $c_table cp ON (cp.id = h.current_copy)
  55                         JOIN $o_table ou ON (ou.id = cp.circ_lib)
  56                   WHERE ou.id = ?
  57                         AND h.capture_time IS NULL
  58                         AND h.cancel_time IS NULL
  59                   ORDER BY h.request_time
  60         SQL
  61
  62         my $sth = action::hold_request->db_Main->prepare_cached($SQL);
  63         $sth->execute($ou);
  64
  65         $client->respond($_) for (
  66                 map {
  67                         $self
  68                                 ->method_lookup('open-ils.storage.direct.action.hold_request.retrieve')
  69                                 ->run($_)
  70                 } map {
  71                         $_->[0]
  72                 } @{ $sth->fetchall_arrayref }
  73         );
  74         return undef;
  75 }
  76 __PACKAGE__->register_method(
  77         api_name        => 'open-ils.storage.action.targeted_hold_request.org_unit',
  78         api_level       => 1,
  79         argc            => 1,
  80         stream          => 1,
  81         method          => 'ou_hold_requests',
  82 );
  83
  84
  85 sub overdue_circs {
  86         my $grace = shift;
  87
  88         my $c_t = action::circulation->table;
  89
  90         $grace = " - ($grace * (fine_interval))" if ($grace);
  91
  92         my $sql = <<"   SQL";
  93                 SELECT  *
  94                   FROM  $c_t
  95                   WHERE stop_fines IS NULL
  96                         AND due_date < ( CURRENT_TIMESTAMP $grace)
  97         SQL
  98
  99         my $sth = action::circulation->db_Main->prepare_cached($sql);
 100         $sth->execute;
 101
 102         return ( map { action::circulation->construct($_) } $sth->fetchall_hash );
 103
 104 }
 105
 106 sub complete_reshelving {
 107         my $self = shift;
 108         my $client = shift;
 109         my $window = shift;
 110
 111         local $OpenILS::Application::Storage::WRITE = 1;
 112
 113         throw OpenSRF::EX::InvalidArg ("I need an interval of more than 0 seconds!")
 114                 unless (interval_to_seconds( $window ));
 115
 116         my $circ = action::circulation->table;
 117         my $cp = asset::copy->table;
 118
 119         my $sql = <<"   SQL";
 120                 UPDATE  $cp
 121                   SET   status = 0
 122                   WHERE id IN ( SELECT  cp.id
 123                                   FROM  $cp cp
 124                                         JOIN $circ circ ON (circ.target_copy = cp.id)
 125                                   WHERE circ.checkin_time IS NOT NULL
 126                                         AND circ.checkin_time < NOW() - CAST(? AS INTERVAL)
 127                                         AND cp.status = 7 )
 128         SQL
 129
 130         my $sth = action::circulation->db_Main->prepare_cached($sql);
 131         $sth->execute($window);
 132
 133         return $sth->rows;
 134
 135 }
 136 __PACKAGE__->register_method(
 137         api_name        => 'open-ils.storage.action.circulation.reshelving.complete',
 138         api_level       => 1,
 139         stream          => 1,
 140         argc            => 1,
 141         method          => 'complete_reshelving',
 142 );
 143
 144 sub grab_overdue {
 145         my $self = shift;
 146         my $client = shift;
 147         my $grace = shift || '';
 148
 149         $client->respond( $_->to_fieldmapper ) for ( overdue_circs($grace) );
 150
 151         return undef;
 152
 153 }
 154 __PACKAGE__->register_method(
 155         api_name        => 'open-ils.storage.action.circulation.overdue',
 156         api_level       => 1,
 157         stream          => 1,
 158         method          => 'grab_overdue',
 159 );
 160
 161 sub nearest_hold {
 162         my $self = shift;
 163         my $client = shift;
 164         my $pl = shift;
 165         my $cp = shift;
 166         my $limit = int(shift()) || 10;
 167
 168         my ($id) = action::hold_request->db_Main->selectrow_array(<<"   SQL", {}, $cp, $pl);
 169                 SELECT  h.id
 170                   FROM  action.hold_request h
 171                         JOIN action.hold_copy_map hm ON (hm.hold = h.id)
 172                         JOIN actor.org_unit_proximity p ON (p.from_org = h.pickup_lib)
 173                   WHERE hm.target_copy = ?
 174                         AND p.to_org = ?
 175                         AND h.capture_time IS NULL
 176                         AND h.cancel_time IS NULL
 177                 ORDER BY
 178                         p.prox,
 179                         h.selection_depth DESC,
 180                         h.request_time
 181                 LIMIT $limit
 182         SQL
 183         return $id;
 184 }
 185 __PACKAGE__->register_method(
 186         api_name        => 'open-ils.storage.action.hold_request.nearest_hold',
 187         api_level       => 1,
 188         stream          => 1,
 189         method          => 'nearest_hold',
 190 );
 191
 192 sub next_resp_group_id {
 193         my $self = shift;
 194         my $client = shift;
 195
 196         # XXX This is not replication safe!!!
 197
 198         my ($id) = action::survey->db_Main->selectrow_array(<<" SQL");
 199                 SELECT NEXTVAL('action.survey_response_group_id_seq'::TEXT)
 200         SQL
 201         return $id;
 202 }
 203 __PACKAGE__->register_method(
 204         api_name        => 'open-ils.storage.action.survey_response.next_group_id',
 205         api_level       => 1,
 206         method          => 'next_resp_group_id',
 207 );
 208
 209 sub patron_circ_summary {
 210         my $self = shift;
 211         my $client = shift;
 212         my $id = ''.shift();
 213
 214         return undef unless ($id);
 215         my $c_table = action::circulation->table;
 216         my $b_table = money::billing->table;
 217
 218         $log->debug("Retrieving patron summary for id $id", DEBUG);
 219
 220         my $select = <<"        SQL";
 221                 SELECT  COUNT(DISTINCT c.id), SUM( COALESCE(b.amount,0) )
 222                   FROM  $c_table c
 223                         LEFT OUTER JOIN $b_table b ON (c.id = b.xact AND b.voided = FALSE)
 224                   WHERE c.usr = ?
 225                         AND c.xact_finish IS NULL
 226                         AND (
 227                                 c.stop_fines NOT IN ('CLAIMSRETURNED','LOST')
 228                                 OR c.stop_fines IS NULL
 229                         )
 230         SQL
 231
 232         return action::survey->db_Main->selectrow_arrayref($select, {}, $id);
 233 }
 234 __PACKAGE__->register_method(
 235         api_name        => 'open-ils.storage.action.circulation.patron_summary',
 236         api_level       => 1,
 237         method          => 'patron_circ_summary',
 238 );
 239
 240 #XXX Fix stored proc calls
 241 sub find_local_surveys {
 242         my $self = shift;
 243         my $client = shift;
 244         my $ou = ''.shift();
 245
 246         return undef unless ($ou);
 247         my $s_table = action::survey->table;
 248
 249         my $select = <<"        SQL";
 250                 SELECT  s.*
 251                   FROM  $s_table s
 252                         JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
 253                   WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
 254         SQL
 255
 256         my $sth = action::survey->db_Main->prepare_cached($select);
 257         $sth->execute($ou);
 258
 259         $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
 260
 261         return undef;
 262 }
 263 __PACKAGE__->register_method(
 264         api_name        => 'open-ils.storage.action.survey.all',
 265         api_level       => 1,
 266         stream          => 1,
 267         method          => 'find_local_surveys',
 268 );
 269
 270 #XXX Fix stored proc calls
 271 sub find_opac_surveys {
 272         my $self = shift;
 273         my $client = shift;
 274         my $ou = ''.shift();
 275
 276         return undef unless ($ou);
 277         my $s_table = action::survey->table;
 278
 279         my $select = <<"        SQL";
 280                 SELECT  s.*
 281                   FROM  $s_table s
 282                         JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
 283                   WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
 284                         AND s.opac IS TRUE;
 285         SQL
 286
 287         my $sth = action::survey->db_Main->prepare_cached($select);
 288         $sth->execute($ou);
 289
 290         $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
 291
 292         return undef;
 293 }
 294 __PACKAGE__->register_method(
 295         api_name        => 'open-ils.storage.action.survey.opac',
 296         api_level       => 1,
 297         stream          => 1,
 298         method          => 'find_opac_surveys',
 299 );
 300
 301 sub hold_pull_list {
 302         my $self = shift;
 303         my $client = shift;
 304         my $ou = shift;
 305         my $limit = shift || 10;
 306         my $offset = shift || 0;
 307
 308         return undef unless ($ou);
 309         my $h_table = action::hold_request->table;
 310         my $a_table = asset::copy->table;
 311
 312         my $select = <<"        SQL";
 313                 SELECT  h.*
 314                   FROM  $h_table h
 315                         JOIN $a_table a ON (h.current_copy = a.id)
 316                   WHERE a.circ_lib = ?
 317                         AND h.capture_time IS NULL
 318                         AND h.cancel_time IS NULL
 319                   ORDER BY h.request_time ASC
 320                   LIMIT $limit
 321                   OFFSET $offset
 322         SQL
 323
 324         my $sth = action::survey->db_Main->prepare_cached($select);
 325         $sth->execute($ou);
 326
 327         $client->respond( $_->to_fieldmapper ) for ( map { action::hold_request->construct($_) } $sth->fetchall_hash );
 328
 329         return undef;
 330 }
 331 __PACKAGE__->register_method(
 332         api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib',
 333         api_level       => 1,
 334         stream          => 1,
 335         signature       => [
 336                 "Returns the holds for a specific library's pull list.",
 337                 [ [org_unit => "The library's org id", "number"],
 338                   [limit => 'An optional page size, defaults to 10', 'number'],
 339                   [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
 340                 ],
 341                 ['A list of holds for the stated library to pull for', 'array']
 342         ],
 343         method          => 'hold_pull_list',
 344 );
 345
 346 sub find_optional_surveys {
 347         my $self = shift;
 348         my $client = shift;
 349         my $ou = ''.shift();
 350
 351         return undef unless ($ou);
 352         my $s_table = action::survey->table;
 353
 354         my $select = <<"        SQL";
 355                 SELECT  s.*
 356                   FROM  $s_table s
 357                         JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
 358                   WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
 359                         AND s.required IS FALSE;
 360         SQL
 361
 362         my $sth = action::survey->db_Main->prepare_cached($select);
 363         $sth->execute($ou);
 364
 365         $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
 366
 367         return undef;
 368 }
 369 __PACKAGE__->register_method(
 370         api_name        => 'open-ils.storage.action.survey.optional',
 371         api_level       => 1,
 372         stream          => 1,
 373         method          => 'find_optional_surveys',
 374 );
 375
 376 sub find_required_surveys {
 377         my $self = shift;
 378         my $client = shift;
 379         my $ou = ''.shift();
 380
 381         return undef unless ($ou);
 382         my $s_table = action::survey->table;
 383
 384         my $select = <<"        SQL";
 385                 SELECT  s.*
 386                   FROM  $s_table s
 387                         JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
 388                   WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
 389                         AND s.required IS TRUE;
 390         SQL
 391
 392         my $sth = action::survey->db_Main->prepare_cached($select);
 393         $sth->execute($ou);
 394
 395         $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
 396
 397         return undef;
 398 }
 399 __PACKAGE__->register_method(
 400         api_name        => 'open-ils.storage.action.survey.required',
 401         api_level       => 1,
 402         stream          => 1,
 403         method          => 'find_required_surveys',
 404 );
 405
 406 sub find_usr_summary_surveys {
 407         my $self = shift;
 408         my $client = shift;
 409         my $ou = ''.shift();
 410
 411         return undef unless ($ou);
 412         my $s_table = action::survey->table;
 413
 414         my $select = <<"        SQL";
 415                 SELECT  s.*
 416                   FROM  $s_table s
 417                         JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
 418                   WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
 419                         AND s.usr_summary IS TRUE;
 420         SQL
 421
 422         my $sth = action::survey->db_Main->prepare_cached($select);
 423         $sth->execute($ou);
 424
 425         $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
 426
 427         return undef;
 428 }
 429 __PACKAGE__->register_method(
 430         api_name        => 'open-ils.storage.action.survey.usr_summary',
 431         api_level       => 1,
 432         stream          => 1,
 433         method          => 'find_usr_summary_surveys',
 434 );
 435
 436
 437 sub generate_fines {
 438         my $self = shift;
 439         my $client = shift;
 440         my $grace = shift;
 441         my $circ = shift;
 442
 443         local $OpenILS::Application::Storage::WRITE = 1;
 444
 445         my @circs;
 446         if ($circ) {
 447                 push @circs, action::circulation->search_where( { id => $circ, stop_fines => undef } );
 448         } else {
 449                 push @circs, overdue_circs($grace);
 450         }
 451
 452         my $penalty = OpenSRF::AppSession->create('open-ils.penalty');
 453         for my $c (@circs) {
 454
 455                 try {
 456                         my $due_dt = $parser->parse_datetime( clense_ISO8601( $c->due_date ) );
 457
 458                         my $due = $due_dt->epoch;
 459                         my $now = time;
 460                         my $fine_interval = interval_to_seconds( $c->fine_interval );
 461
 462                         if ( interval_to_seconds( $c->fine_interval ) >= interval_to_seconds('1d') ) {
 463                                 my $tz_offset_s = 0;
 464                                 if ($due_dt->strftime('%z') =~ /(-|\+)(\d{2}):?(\d{2})/) {
 465                                         $tz_offset_s = $1 . interval_to_seconds( "${2}h ${3}m");
 466                                 }
 467
 468                                 $due -= ($due % $fine_interval) + $tz_offset_s;
 469                                 $now -= ($now % $fine_interval) + $tz_offset_s;
 470                         }
 471
 472                         $client->respond(
 473                                 "ARG! Overdue circulation ".$c->id.
 474                                 " for item ".$c->target_copy.
 475                                 " (user ".$c->usr.").\n".
 476                                 "\tItem was due on or before: ".localtime($due)."\n");
 477
 478                         my ($fine) = money::billing->search(
 479                                 xact => $c->id, voided => 'f',
 480                                 { order_by => 'billing_ts DESC', limit => '1' }
 481                         );
 482
 483                         my $last_fine;
 484                         if ($fine) {
 485                                 $client->respond( "Last billing time: ".$fine->billing_ts." (clensed fromat: ".clense_ISO8601( $fine->billing_ts ).")");
 486                                 $last_fine = $parser->parse_datetime( clense_ISO8601( $fine->billing_ts ) )->epoch;
 487                         } else {
 488                                 $last_fine = $due;
 489
 490                                 # XXX There is some contention over this ... it basically makes the grace period "hard" (non-fining)
 491                                 #$last_fine += $fine_interval * $grace;
 492                         }
 493
 494                         my $pending_fine_count = int( ($now - $last_fine) / $fine_interval ) - 1;
 495                         if ($pending_fine_count < 1) {
 496                                 $client->respond( "\tNo fines to create.  " );
 497                                 if ($grace && $now < $due + $fine_interval * $grace) {
 498                                         $client->respond( "Still inside grace period of: ". seconds_to_interval( $fine_interval * $grace)."\n" );
 499                                 } else {
 500                                         $client->respond( "Last fine generated for: ".localtime($last_fine)."\n" );
 501                                 }
 502                                 next;
 503                         }
 504
 505                         $client->respond( "\t$pending_fine_count pending fine(s)\n" );
 506
 507                         for (my $bill = 1; $bill <= $pending_fine_count; $bill++) {
 508
 509                                 my ($total) = money::billable_transaction_summary->retrieve( $c->id );
 510
 511                                 if ($total && $total->total_owed > $c->max_fine) {
 512                                         $c->update({stop_fines => 'MAXFINES'});
 513                                         $client->respond(
 514                                                 "\tMaximum fine level of ".$c->max_fine.
 515                                                 " reached for this circulation.\n".
 516                                                 "\tNo more fines will be generated.\n" );
 517                                         last;
 518                                 }
 519
 520                                 my $billing_ts = DateTime->from_epoch( epoch => $last_fine + $fine_interval * $bill );
 521
 522                                 my $dow = $billing_ts->dow;
 523                                 my $dow_open = "dow_${dow}_open";
 524                                 my $dow_close = "dow_${dow}_close";
 525
 526                                 if (my $hoo = actor::org_unit::hours_of_operation->retrieve( $c->circ_lib )) {
 527                                         next if ( $hoo->$dow_open eq '00:00:00' and $hoo->$dow_close eq '00:00:00');
 528                                 }
 529
 530                                 my $timestamptz = $billing_ts->strftime('%FT%T%z');
 531                                 my @cl = actor::org_unit::closed_date->search_where(
 532                                                 { close_start   => { '<=' => $timestamptz },
 533                                                   close_end     => { '>=' => $timestamptz },
 534                                                   org_unit      => $c->circ_lib }
 535                                 );
 536                                 next if (@cl);
 537
 538                                 my $billing = money::billing->create(
 539                                         { xact          => ''.$c->id,
 540                                           note          => "Overdue Fine",
 541                                           billing_type  => "Overdue materials",
 542                                           amount        => ''.$c->recuring_fine,
 543                                           billing_ts    => $timestamptz,
 544                                         }
 545                                 );
 546
 547                                 $client->respond(
 548                                         "\t\tCreating fine of ".$billing->amount." for period starting ".
 549                                         localtime(
 550                                                 $parser->parse_datetime(
 551                                                         clense_ISO8601( $billing->billing_ts )
 552                                                 )->epoch
 553                                         )."\n" );
 554                         }
 555
 556                         $penalty->request(
 557                                 'open-ils.penalty.patron_penalty.calculate',
 558                                 { patron        => $c->usr->to_fieldmapper,
 559                                   update        => 1,
 560                                   background    => 1,
 561                                 }
 562                         )->gather(1);
 563
 564                 } catch Error with {
 565                         my $e = shift;
 566                         $client->respond( "Error processing overdue circulation [".$c->id."]:\n\n$e\n" );
 567                 };
 568         }
 569 }
 570 __PACKAGE__->register_method(
 571         api_name        => 'open-ils.storage.action.circulation.overdue.generate_fines',
 572         api_level       => 1,
 573         stream          => 1,
 574         method          => 'generate_fines',
 575 );
 576
 577
 578
 579 sub new_hold_copy_targeter {
 580         my $self = shift;
 581         my $client = shift;
 582         my $check_expire = shift;
 583         my $one_hold = shift;
 584
 585         local $OpenILS::Application::Storage::WRITE = 1;
 586
 587         my $holds;
 588
 589         try {
 590                 if ($one_hold) {
 591                         $holds = [ action::hold_request->search_where( { id => $one_hold, fulfillment_time => undef, cancel_time => undef } ) ];
 592                 } elsif ( $check_expire ) {
 593
 594                         my $time = time;
 595                         $check_expire ||= '12h';
 596                         $check_expire = interval_to_seconds( $check_expire );
 597
 598                         my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() - $check_expire);
 599                         $year += 1900;
 600                         $mon += 1;
 601                         my $expire_threshold = sprintf(
 602                                 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
 603                                 $year, $mon, $mday, $hour, $min, $sec
 604                         );
 605
 606                         $holds = [ action::hold_request->search_where(
 607                                                         { capture_time => undef,
 608                                                           fulfillment_time => undef,
 609                                                           cancel_time => undef,
 610                                                           prev_check_time => { '<=' => $expire_threshold },
 611                                                         },
 612                                                         { order_by => 'selection_depth DESC, request_time,prev_check_time' } ) ];
 613                         push @$holds, action::hold_request->search(
 614                                                         capture_time => undef,
 615                                                         fulfillment_time => undef,
 616                                                         prev_check_time => undef,
 617                                                         cancel_time => undef,
 618                                                         { order_by => 'selection_depth DESC, request_time' } );
 619                 } else {
 620                         $holds = [ action::hold_request->search(
 621                                                         capture_time => undef,
 622                                                         fulfillment_time => undef,
 623                                                         prev_check_time => undef,
 624                                                         cancel_time => undef,
 625                                                         { order_by => 'selection_depth DESC, request_time' } ) ];
 626                 }
 627         } catch Error with {
 628                 my $e = shift;
 629                 die "Could not retrieve uncaptured hold requests:\n\n$e\n";
 630         };
 631
 632         my @successes;
 633
 634         for my $hold (@$holds) {
 635                 try {
 636                         #action::hold_request->db_Main->begin_work;
 637                         if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
 638                                 $log->debug("Cleaning up after previous transaction\n");
 639                                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
 640                         }
 641                         $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
 642                         $log->info("Processing hold ".$hold->id."...\n");
 643
 644                         action::hold_copy_map->search( hold => $hold->id )->delete_all;
 645
 646                         my $all_copies = [];
 647
 648                         my ($types, $formats, $lang) = split '-', $hold->holdable_formats;
 649
 650                         # find all the potential copies
 651                         if ($hold->hold_type eq 'M') {
 652                                 for my $r ( map
 653                                                 {$_->record}
 654                                                 metabib::record_descriptor
 655                                                         ->search(
 656                                                                 record => [ map { $_->id } metabib::metarecord->retrieve($hold->target)->source_records ],
 657                                                                 ( $types   ? (item_type => [split '', $types])   : () ),
 658                                                                 ( $formats ? (item_form => [split '', $formats]) : () ),
 659                                                                 ( $lang    ? (item_lang => $lang)                : () ),
 660                                                         )
 661                                 ) {
 662                                         my ($rtree) = $self
 663                                                 ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
 664                                                 ->run( $r->id, $hold->selection_ou, $hold->selection_depth );
 665
 666                                         for my $cn ( @{ $rtree->call_numbers } ) {
 667                                                 push @$all_copies,
 668                                                         asset::copy->search( id => [map {$_->id} @{ $cn->copies }] );
 669                                         }
 670                                 }
 671                         } elsif ($hold->hold_type eq 'T') {
 672                                 my ($rtree) = $self
 673                                         ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
 674                                         ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
 675
 676                                 unless ($rtree) {
 677                                         push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_RECORD' };
 678                                         die 'OK';
 679                                 }
 680
 681                                 for my $cn ( @{ $rtree->call_numbers } ) {
 682                                         push @$all_copies,
 683                                                 asset::copy->search( id => [map {$_->id} @{ $cn->copies }] );
 684                                 }
 685                         } elsif ($hold->hold_type eq 'V') {
 686                                 my ($vtree) = $self
 687                                         ->method_lookup( 'open-ils.storage.asset.call_number.ranged_tree')
 688                                         ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
 689
 690                                 push @$all_copies,
 691                                         asset::copy->search( id => [map {$_->id} @{ $vtree->copies }] );
 692
 693                         } elsif  ($hold->hold_type eq 'C') {
 694
 695                                 $all_copies = [asset::copy->retrieve($hold->target)];
 696                         }
 697
 698                         @$all_copies = grep {   $_->status->holdable &&
 699                                                 $_->location->holdable &&
 700                                                 $_->holdable
 701                                         } @$all_copies;
 702
 703                         # let 'em know we're still working
 704                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
 705
 706                         if (!ref $all_copies || !@$all_copies) {
 707                                 $log->info("\tNo copies available for targeting at all!\n");
 708                                 $self->method_lookup('open-ils.storage.transaction.commit')->run;
 709                                 push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_COPIES' };
 710                                 die 'OK';
 711                         }
 712
 713                         my $copy_count = @$all_copies;
 714
 715                         # map the potentials, so that we can pick up checkins
 716                         $log->debug( "\tMapping ".scalar(@$all_copies)." potential copies for hold ".$hold->id);
 717                         action::hold_copy_map->create( { hold => $hold->id, target_copy => $_->id } ) for (@$all_copies);
 718
 719                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
 720
 721                         my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime();
 722                         $year += 1900;
 723                         $mon += 1;
 724                         my $today= sprintf( '%s-%0.2d-%0.2d', $year, $mon, $mday );
 725
 726                         my @closed = actor::org_unit::closed_date->search_where(
 727                                 { close_start => { '<=', $today },
 728                                   close_end => { '>=', $today } }
 729                         );
 730
 731                         my @good_copies;
 732                         for my $c (@$all_copies) {
 733                                 next if ($c->id == $hold->current_copy);
 734                                 next if ( grep { ''.$_->org_unit == ''.$c->circ_lib } @closed );
 735                                 next if (action::hold_request
 736                                                 ->search_where(
 737                                                         { current_copy => $c->id,
 738                                                           capture_time => undef,
 739                                                           cancel_time => undef,
 740                                                         }
 741                                                 )
 742                                 );
 743                                 push @good_copies, $c if ($c);
 744                                 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
 745                         }
 746
 747                         $log->debug("\t".scalar(@good_copies)." (non-current) copies available for targeting...");
 748
 749                         my $old_best = $hold->current_copy;
 750                         $hold->update({ current_copy => undef });
 751
 752                         if (!scalar(@good_copies)) {
 753                                 $log->info("\tNo (non-current) copies eligible to fill the hold.");
 754                                 if (
 755                                   $old_best &&
 756                                   grep { $old_best eq $_ } @$all_copies &&
 757                                   !action::hold_request->search_where({ current_copy => $old_best->id, capture_time => undef, cancel_time => undef })
 758                                 ) {
 759                                         $log->debug("\tPushing current_copy back onto the targeting list");
 760                                         push @good_copies, $old_best;
 761                                 } else {
 762                                         $log->debug("\tcurrent_copy is no longer available for targeting... NEXT HOLD, PLEASE!");
 763                                         $self->method_lookup('open-ils.storage.transaction.commit')->run;
 764                                         push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_TARGETS' };
 765                                         die 'OK';
 766                                 }
 767                         }
 768
 769                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
 770                         my $prox_list = [];
 771                         $$prox_list[0] =
 772                         [
 773                                 grep {
 774                                         $_->circ_lib == $hold->pickup_lib
 775                                 } @good_copies
 776                         ];
 777
 778                         $all_copies = [grep {$_->circ_lib != $hold->pickup_lib } @good_copies];
 779
 780                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
 781                         my $best = choose_nearest_copy($hold, $prox_list);
 782                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
 783
 784                         if (!$best) {
 785                                 $log->debug("\tNothing at the pickup lib, looking elsewhere among ".scalar(@$all_copies)." copies");
 786                                 $prox_list = create_prox_list( $self, $hold->pickup_lib, $all_copies );
 787
 788                                 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
 789
 790                                 $best = choose_nearest_copy($hold, $prox_list);
 791                         }
 792
 793                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
 794                         if ($old_best) {
 795                                 # hold wasn't fulfilled, record the fact
 796
 797                                 $log->info("\tHold was not (but should have been) fulfilled by ".$old_best->id);
 798                                 action::unfulfilled_hold_list->create(
 799                                                 { hold => ''.$hold->id,
 800                                                   current_copy => ''.$old_best->id,
 801                                                   circ_lib => ''.$old_best->circ_lib,
 802                                                 });
 803                         }
 804
 805                         if ($best) {
 806                                 $hold->update( { current_copy => ''.$best->id } );
 807                                 $log->debug("\tUpdating hold [".$hold->id."] with new 'current_copy' [".$best->id."] for hold fulfillment.");
 808                         } else {
 809                                 $log->info( "\tThere were no targetable copies for the hold" );
 810                         }
 811
 812                         $hold->update( { prev_check_time => 'now' } );
 813
 814                         $self->method_lookup('open-ils.storage.transaction.commit')->run;
 815                         $log->info("\tProcessing of hold ".$hold->id." complete.");
 816
 817                         push @successes,
 818                                 { hold => $hold->id,
 819                                   old_target => ($old_best ? $old_best->id : undef),
 820                                   eligible_copies => $copy_count,
 821                                   target => ($best ? $best->id : undef) };
 822
 823                 } otherwise {
 824                         my $e = shift;
 825                         if ($e !~ /^OK/o) {
 826                                 $log->error("Processing of hold failed:  $e");
 827                                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
 828                         }
 829                 };
 830         }
 831
 832         return \@successes;
 833 }
 834 __PACKAGE__->register_method(
 835         api_name        => 'open-ils.storage.action.hold_request.copy_targeter',
 836         api_level       => 1,
 837         method          => 'new_hold_copy_targeter',
 838 );
 839
 840 my $locations;
 841 my $statuses;
 842 my %cache = (titles => {}, cns => {});
 843 sub hold_copy_targeter {
 844         my $self = shift;
 845         my $client = shift;
 846         my $check_expire = shift;
 847         my $one_hold = shift;
 848
 849         $self->{user_filter} = OpenSRF::AppSession->create('open-ils.circ');
 850         $self->{user_filter}->connect;
 851         $self->{client} = $client;
 852
 853         my $time = time;
 854         $check_expire ||= '12h';
 855         $check_expire = interval_to_seconds( $check_expire );
 856
 857         my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() - $check_expire);
 858         $year += 1900;
 859         $mon += 1;
 860         my $expire_threshold = sprintf(
 861                 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
 862                 $year, $mon, $mday, $hour, $min, $sec
 863         );
 864
 865
 866         $statuses ||= [ config::copy_status->search(holdable => 't') ];
 867
 868         $locations ||= [ asset::copy_location->search(holdable => 't') ];
 869
 870         my $holds;
 871
 872         %cache = (titles => {}, cns => {});
 873
 874         try {
 875                 if ($one_hold) {
 876                         $holds = [ action::hold_request->search(id => $one_hold) ];
 877                 } else {
 878                         $holds = [ action::hold_request->search_where(
 879                                                         { capture_time => undef,
 880                                                           prev_check_time => { '<=' => $expire_threshold },
 881                                                         },
 882                                                         { order_by => 'request_time,prev_check_time' } ) ];
 883                         push @$holds, action::hold_request->search_where(
 884                                                         { capture_time => undef,
 885                                                           prev_check_time => undef,
 886                                                         },
 887                                                         { order_by => 'request_time' } );
 888                 }
 889         } catch Error with {
 890                 my $e = shift;
 891                 die "Could not retrieve uncaptured hold requests:\n\n$e\n";
 892         };
 893
 894         for my $hold (@$holds) {
 895                 try {
 896                         #action::hold_request->db_Main->begin_work;
 897                         if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
 898                                 $client->respond("Cleaning up after previous transaction\n");
 899                                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
 900                         }
 901                         $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
 902                         $client->respond("Processing hold ".$hold->id."...\n");
 903
 904                         my $copies;
 905
 906                         $copies = $self->metarecord_hold_capture($hold) if ($hold->hold_type eq 'M');
 907                         $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
 908
 909                         $copies = $self->title_hold_capture($hold) if ($hold->hold_type eq 'T');
 910                         $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
 911
 912                         $copies = $self->volume_hold_capture($hold) if ($hold->hold_type eq 'V');
 913                         $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
 914
 915                         $copies = $self->copy_hold_capture($hold) if ($hold->hold_type eq 'C');
 916
 917                         unless (ref $copies || !@$copies) {
 918                                 $client->respond("\tNo copies available for targeting at all!\n");
 919                         }
 920
 921                         my @good_copies;
 922                         for my $c (@$copies) {
 923                                 next if ( grep {$c->id == $hold->current_copy} @good_copies);
 924                                 push @good_copies, $c if ($c);
 925                         }
 926
 927                         $client->respond("\t".scalar(@good_copies)." (non-current) copies available for targeting...\n");
 928
 929                         my $old_best = $hold->current_copy;
 930                         $hold->update({ current_copy => undef });
 931
 932                         if (!scalar(@good_copies)) {
 933                                 $client->respond("\tNo (non-current) copies available to fill the hold.\n");
 934                                 if ( $old_best && grep {$c->id == $hold->current_copy} @$copies ) {
 935                                         $client->respond("\tPushing current_copy back onto the targeting list\n");
 936                                         push @good_copies, asset::copy->retrieve( $old_best );
 937                                 } else {
 938                                         $client->respond("\tcurrent_copy is no longer available for targeting... NEXT HOLD, PLEASE!\n");
 939                                         next;
 940                                 }
 941                         }
 942
 943                         my $prox_list;
 944                         $$prox_list[0] = [grep {$_->circ_lib == $hold->pickup_lib } @good_copies];
 945                         $copies = [grep {$_->circ_lib != $hold->pickup_lib } @good_copies];
 946
 947                         my $best = choose_nearest_copy($hold, $prox_list);
 948
 949                         if (!$best) {
 950                                 $prox_list = create_prox_list( $self, $hold->pickup_lib, $copies );
 951                                 $best = choose_nearest_copy($hold, $prox_list);
 952                         }
 953
 954                         if ($old_best) {
 955                                 # hold wasn't fulfilled, record the fact
 956
 957                                 $client->respond("\tHold was not (but should have been) fulfilled by ".$old_best->id.".\n");
 958                                 action::unfulfilled_hold_list->create(
 959                                                 { hold => ''.$hold->id,
 960                                                   current_copy => ''.$old_best->id,
 961                                                   circ_lib => ''.$old_best->circ_lib,
 962                                                 });
 963                         }
 964
 965                         if ($best) {
 966                                 $hold->update( { current_copy => ''.$best->id } );
 967                                 $client->respond("\tTargeting copy ".$best->id." for hold fulfillment.\n");
 968                         }
 969
 970                         $hold->update( { prev_check_time => 'now' } );
 971                         $client->respond("\tUpdating hold ".$hold->id." with new 'current_copy' for hold fulfillment.\n");
 972
 973                         $client->respond("\tProcessing of hold ".$hold->id." complete.\n");
 974                         $self->method_lookup('open-ils.storage.transaction.commit')->run;
 975
 976                         #action::hold_request->dbi_commit;
 977
 978                 } otherwise {
 979                         my $e = shift;
 980                         $log->error("Processing of hold failed:  $e");
 981                         $client->respond("\tProcessing of hold failed!.\n\t\t$e\n");
 982                         $self->method_lookup('open-ils.storage.transaction.rollback')->run;
 983                         #action::hold_request->dbi_rollback;
 984                 };
 985         }
 986
 987         $self->{user_filter}->disconnect;
 988         $self->{user_filter}->finish;
 989         delete $$self{user_filter};
 990         return undef;
 991 }
 992 __PACKAGE__->register_method(
 993         api_name        => 'open-ils.storage.action.hold_request.copy_targeter',
 994         api_level       => 0,
 995         stream          => 1,
 996         method          => 'hold_copy_targeter',
 997 );
 998
 999
1000 sub copy_hold_capture {
1001         my $self = shift;
1002         my $hold = shift;
1003         my $cps = shift;
1004
1005         if (!defined($cps)) {
1006                 try {
1007                         $cps = [ asset::copy->search( id => $hold->target ) ];
1008                 } catch Error with {
1009                         my $e = shift;
1010                         die "Could not retrieve initial volume list:\n\n$e\n";
1011                 };
1012         }
1013
1014         my @copies = grep { $_->holdable } @$cps;
1015
1016         for (my $i = 0; $i < @$cps; $i++) {
1017                 next unless $$cps[$i];
1018
1019                 my $cn = $cache{cns}{$copies[$i]->call_number};
1020                 my $rec = $cache{titles}{$cn->record};
1021                 $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->status eq $_->id}@$statuses);
1022                 $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->location eq $_->id}@$locations);
1023                 $copies[$i] = undef if (
1024                         !$copies[$i] ||
1025                         !$self->{user_filter}->request(
1026                                 'open-ils.circ.permit_hold',
1027                                 $hold->to_fieldmapper, do {
1028                                         my $cp_fm = $copies[$i]->to_fieldmapper;
1029                                         $cp_fm->circ_lib( $copies[$i]->circ_lib->to_fieldmapper );
1030                                         $cp_fm->location( $copies[$i]->location->to_fieldmapper );
1031                                         $cp_fm->status( $copies[$i]->status->to_fieldmapper );
1032                                         $cp_fm;
1033                                 },
1034                                 { title => $rec->to_fieldmapper,
1035                                   usr => actor::user->retrieve($hold->usr)->to_fieldmapper,
1036                                   requestor => actor::user->retrieve($hold->requestor)->to_fieldmapper,
1037                                 })->gather(1)
1038                 );
1039                 $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
1040         }
1041
1042         @copies = grep { $_ } @copies;
1043
1044         my $count = @copies;
1045
1046         return unless ($count);
1047
1048         action::hold_copy_map->search( hold => $hold->id )->delete_all;
1049
1050         my @maps;
1051         $self->{client}->respond( "\tMapping ".scalar(@copies)." eligable copies for hold ".$hold->id."\n");
1052         for my $c (@copies) {
1053                 push @maps, action::hold_copy_map->create( { hold => $hold->id, target_copy => $c->id } );
1054         }
1055         $self->{client}->respond( "\tA total of ".scalar(@maps)." mapping were created for hold ".$hold->id."\n");
1056
1057         return \@copies;
1058 }
1059
1060
1061 sub choose_nearest_copy {
1062         my $hold = shift;
1063         my $prox_list = shift;
1064
1065         for my $p ( 0 .. int( scalar(@$prox_list) - 1) ) {
1066                 next unless (ref $$prox_list[$p]);
1067
1068                 my @capturable = grep { $_->status == 0 || $_->status == 7 } @{ $$prox_list[$p] };
1069                 next unless (@capturable);
1070
1071                 my $rand = int(rand(scalar(@capturable)));
1072                 while (my ($c) = splice(@capturable,$rand)) {
1073                         unless ( OpenILS::Utils::PermitHold::permit_copy_hold(
1074                                 { title => $c->call_number->record->to_fieldmapper,
1075                                   title_descriptor => $c->call_number->record->record_descriptor->next->to_fieldmapper,
1076                                   patron => $hold->usr->to_fieldmapper,
1077                                   copy => $c->to_fieldmapper,
1078                                   requestor => $hold->requestor->to_fieldmapper,
1079                                   request_lib => $hold->request_lib->to_fieldmapper,
1080                                 }
1081                         )) {
1082                                 last unless(@capturable);
1083                                 $rand = int(rand(scalar(@capturable)));
1084                                 next;
1085                         }
1086                         return $c;
1087                 }
1088         }
1089 }
1090
1091 sub create_prox_list {
1092         my $self = shift;
1093         my $lib = shift;
1094         my $copies = shift;
1095
1096         my @prox_list;
1097         for my $cp (@$copies) {
1098                 my ($prox) = $self->method_lookup('open-ils.storage.asset.copy.proximity')->run( $cp, $lib );
1099                 next unless (defined($prox));
1100                 $prox_list[$prox] = [] unless defined($prox_list[$prox]);
1101                 push @{$prox_list[$prox]}, $cp;
1102         }
1103         return \@prox_list;
1104 }
1105
1106 sub volume_hold_capture {
1107         my $self = shift;
1108         my $hold = shift;
1109         my $vols = shift;
1110
1111         if (!defined($vols)) {
1112                 try {
1113                         $vols = [ asset::call_number->search( id => $hold->target ) ];
1114                         $cache{cns}{$_->id} = $_ for (@$vols);
1115                 } catch Error with {
1116                         my $e = shift;
1117                         die "Could not retrieve initial volume list:\n\n$e\n";
1118                 };
1119         }
1120
1121         my @v_ids = map { $_->id } @$vols;
1122
1123         my $cp_list;
1124         try {
1125                 $cp_list = [ asset::copy->search( call_number => \@v_ids ) ];
1126
1127         } catch Error with {
1128                 my $e = shift;
1129                 warn "Could not retrieve copy list:\n\n$e\n";
1130         };
1131
1132         $self->copy_hold_capture($hold,$cp_list) if (ref $cp_list and @$cp_list);
1133 }
1134
1135 sub title_hold_capture {
1136         my $self = shift;
1137         my $hold = shift;
1138         my $titles = shift;
1139
1140         if (!defined($titles)) {
1141                 try {
1142                         $titles = [ biblio::record_entry->search( id => $hold->target ) ];
1143                         $cache{titles}{$_->id} = $_ for (@$titles);
1144                 } catch Error with {
1145                         my $e = shift;
1146                         die "Could not retrieve initial title list:\n\n$e\n";
1147                 };
1148         }
1149
1150         my @t_ids = map { $_->id } @$titles;
1151         my $cn_list;
1152         try {
1153                 ($cn_list) = $self->method_lookup('open-ils.storage.direct.asset.call_number.search.record.atomic')->run( \@t_ids );
1154
1155         } catch Error with {
1156                 my $e = shift;
1157                 warn "Could not retrieve volume list:\n\n$e\n";
1158         };
1159
1160         $cache{cns}{$_->id} = $_ for (@$cn_list);
1161
1162         $self->volume_hold_capture($hold,$cn_list) if (ref $cn_list and @$cn_list);
1163 }
1164
1165 sub metarecord_hold_capture {
1166         my $self = shift;
1167         my $hold = shift;
1168
1169         my $titles;
1170         try {
1171                 $titles = [ metabib::metarecord_source_map->search( metarecord => $hold->target) ];
1172
1173         } catch Error with {
1174                 my $e = shift;
1175                 die "Could not retrieve initial title list:\n\n$e\n";
1176         };
1177
1178         try {
1179                 my @recs = map {$_->record} metabib::record_descriptor->search( record => $titles, item_type => [split '', $hold->holdable_formats] );
1180
1181                 $titles = [ biblio::record_entry->search( id => \@recs ) ];
1182
1183         } catch Error with {
1184                 my $e = shift;
1185                 die "Could not retrieve format-pruned title list:\n\n$e\n";
1186         };
1187
1188
1189         $cache{titles}{$_->id} = $_ for (@$titles);
1190         $self->title_hold_capture($hold,$titles) if (ref $titles and @$titles);
1191 }
1192
1193 1;