Open-ILS/src/perlmods/OpenILS/Application/Circ/Rules.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 package OpenILS::Application::Circ::Rules;
  17 use base qw/OpenSRF::Application/;
  18 use strict; use warnings;
  19
  20 use OpenSRF::Utils::SettingsClient;
  21 use OpenILS::Utils::Fieldmapper;
  22 use OpenILS::EX;
  23 use OpenSRF::Utils::Logger qw(:level);
  24
  25 use Template qw(:template);
  26 use Template::Stash;
  27
  28 use Time::HiRes qw(time);
  29 use OpenILS::Utils::ModsParser;
  30
  31 use OpenSRF::Utils;
  32 use OpenSRF::EX qw(:try);
  33
  34 use OpenILS::Application::AppUtils;
  35 my $apputils = "OpenILS::Application::AppUtils";
  36 use Digest::MD5 qw(md5_hex);
  37
  38 my $log = "OpenSRF::Utils::Logger";
  39
  40 # ----------------------------------------------------------------
  41 # rules scripts
  42 my $circ_script;
  43 my $permission_script;
  44 my $duration_script;
  45 my $recurring_fines_script;
  46 my $max_fines_script;
  47 my $permit_hold_script;
  48 my $permit_renew_script;
  49 # ----------------------------------------------------------------
  50
  51
  52 # data used for this circulation transaction
  53 my $circ_objects = {};
  54
  55 # some static data from the database
  56 my $copy_statuses;
  57 my $patron_standings;
  58 my $patron_profiles;
  59 my $shelving_locations;
  60
  61 # template stash
  62 my $stash;
  63
  64 # memcache for caching the circ objects
  65 my $cache_handle;
  66
  67
  68 use constant NO_COPY => 100;
  69
  70 sub initialize {
  71
  72         my $self = shift;
  73         my $conf = OpenSRF::Utils::SettingsClient->new;
  74
  75         # ----------------------------------------------------------------
  76         # set up the rules scripts
  77         # ----------------------------------------------------------------
  78         $circ_script = $conf->config_value(
  79                 "apps", "open-ils.circ","app_settings", "rules", "main");
  80
  81         $permission_script = $conf->config_value(
  82                 "apps", "open-ils.circ","app_settings", "rules", "permission");
  83
  84         $duration_script = $conf->config_value(
  85                 "apps", "open-ils.circ","app_settings", "rules", "duration");
  86
  87         $recurring_fines_script = $conf->config_value(
  88                 "apps", "open-ils.circ","app_settings", "rules", "recurring_fines");
  89
  90         $max_fines_script = $conf->config_value(
  91                 "apps", "open-ils.circ","app_settings", "rules", "max_fines");
  92
  93         $permit_hold_script = $conf->config_value(
  94                 "apps", "open-ils.circ","app_settings", "rules", "permit_hold");
  95
  96         $permit_renew_script = $conf->config_value(
  97                 "apps", "open-ils.circ","app_settings", "rules", "permit_renew");
  98
  99         $log->debug("Loaded rules scripts for circ:\n".
 100                 "main - $circ_script : permit circ - $permission_script\n".
 101                 "duration - $duration_script : recurring - $recurring_fines_script\n".
 102                 "max fines - $max_fines_script : permit hold - $permit_hold_script", DEBUG);
 103
 104
 105         $cache_handle = OpenSRF::Utils::Cache->new();
 106 }
 107
 108
 109 sub _grab_patron_standings {
 110         my $session = shift;
 111         if(!$patron_standings) {
 112                 my $standing_req = $session->request(
 113                         "open-ils.storage.direct.config.standing.retrieve.all.atomic");
 114                 $patron_standings = $standing_req->gather(1);
 115                 $patron_standings =
 116                         { map { (''.$_->id => $_->value) } @$patron_standings };
 117         }
 118 }
 119
 120 sub _grab_patron_profiles {
 121         my $session = shift;
 122         if(!$patron_profiles) {
 123                 my $profile_req = $session->request(
 124                         "open-ils.storage.direct.actor.profile.retrieve.all.atomic");
 125                 $patron_profiles = $profile_req->gather(1);
 126                 $patron_profiles =
 127                         { map { (''.$_->id => $_->name) } @$patron_profiles };
 128         }
 129
 130 }
 131
 132 sub _grab_user {
 133         my $session = shift;
 134         my $patron_id = shift;
 135         my $patron_req  = $session->request(
 136                 "open-ils.storage.direct.actor.user.retrieve",
 137                 $patron_id );
 138         return $patron_req->gather(1);
 139 }
 140
 141
 142 sub _grab_title_by_copy {
 143         my $session = shift;
 144         my $copyid = shift;
 145         my $title_req   = $session->request(
 146                 "open-ils.storage.fleshed.biblio.record_entry.retrieve_by_copy",
 147                 $copyid );
 148         return $title_req->gather(1);
 149 }
 150
 151 sub _grab_patron_summary {
 152         my $session = shift;
 153         my $patron_id = shift;
 154         my $summary_req = $session->request(
 155                 "open-ils.storage.action.circulation.patron_summary",
 156                 $patron_id );
 157         return $summary_req->gather(1);
 158 }
 159
 160 sub _grab_copy_by_barcode {
 161         my($session, $barcode) = @_;
 162         warn "Searching for copy with barcode $barcode\n";
 163         my $copy_req    = $session->request(
 164                 "open-ils.storage.fleshed.asset.copy.search.barcode",
 165                 $barcode );
 166         return $copy_req->gather(1);
 167 }
 168
 169 sub _grab_copy_by_id {
 170         my($session, $id) = @_;
 171         warn "Searching for copy with id $id\n";
 172         my $copy_req    = $session->request(
 173                 "open-ils.storage.direct.asset.copy.retrieve",
 174                 $id );
 175         my $c = $copy_req->gather(1);
 176         if($c) { return _grab_copy_by_barcode($session, $c->barcode); }
 177         return undef;
 178 }
 179
 180
 181 sub gather_hold_objects {
 182         my($session, $hold, $copy, $args) = @_;
 183
 184         _grab_patron_standings($session);
 185         _grab_patron_profiles($session);
 186
 187
 188         # flesh me
 189         $copy = _grab_copy_by_barcode($session, $copy->barcode);
 190
 191         my $hold_objects = {};
 192         $hold_objects->{standings} = $patron_standings;
 193         $hold_objects->{copy}           = $copy;
 194         $hold_objects->{hold}           = $hold;
 195         $hold_objects->{title}          = $$args{title} || _grab_title_by_copy($session, $copy->id);
 196         $hold_objects->{requestor} = _grab_user($session, $hold->requestor);
 197         my $patron                                              = _grab_user($session, $hold->usr);
 198
 199         $copy->status( $copy->status->name );
 200         $patron->standing($patron_standings->{$patron->standing()});
 201         $patron->profile( $patron_profiles->{$patron->profile});
 202
 203         $hold_objects->{patron}         = $patron;
 204
 205         return $hold_objects;
 206 }
 207
 208
 209
 210 __PACKAGE__->register_method(
 211         method  => "permit_hold",
 212         api_name        => "open-ils.circ.permit_hold",
 213         notes           => <<"  NOTES");
 214         Determines whether a given copy is eligible to be held
 215         NOTES
 216
 217 sub permit_hold {
 218         my( $self, $client, $hold, $copy, $args ) = @_;
 219
 220         my $session     = OpenSRF::AppSession->create("open-ils.storage");
 221
 222         # collect items necessary for circ calculation
 223         my $hold_objects = gather_hold_objects( $session, $hold, $copy, $args );
 224
 225         $stash = Template::Stash->new(
 226                         circ_objects                    => $hold_objects,
 227                         result                                  => []);
 228
 229         $stash->set("run_block", $permit_hold_script);
 230
 231         # grab the number of copies checked out by the patron as
 232         # well as the total fines
 233         my $summary = _grab_patron_summary($session, $hold_objects->{patron}->id);
 234         $summary->[0] ||= 0;
 235         $summary->[1] ||= 0.0;
 236
 237         $stash->set("patron_copies", $summary->[0] );
 238         $stash->set("patron_fines", $summary->[1] );
 239
 240         # run the permissibility script
 241         run_script();
 242         my $result = $stash->get("result");
 243
 244         # 0 means OK in the script
 245         return 1 if($result->[0] == 0);
 246         return 0;
 247
 248 }
 249
 250
 251
 252
 253
 254 # ----------------------------------------------------------------
 255 # Collect all of the objects necessary for calculating the
 256 # circ matrix.
 257 # ----------------------------------------------------------------
 258 sub gather_circ_objects {
 259         my( $session, $barcode_string, $patron_id ) = @_;
 260
 261         throw OpenSRF::EX::ERROR
 262                 ("gather_circ_objects needs data")
 263                         unless ($barcode_string and $patron_id);
 264
 265         warn "Gathering circ objects with barcode $barcode_string and patron id $patron_id\n";
 266
 267         # see if all of the circ objects are in cache
 268         my $cache_key =  "circ_object_" . md5_hex( $barcode_string, $patron_id );
 269         $circ_objects = $cache_handle->get_cache($cache_key);
 270
 271         if($circ_objects) {
 272                 $stash = Template::Stash->new(
 273                         circ_objects                    => $circ_objects,
 274                         result                                  => [],
 275                         target_copy_status      => 1,
 276                         );
 277                 return;
 278         }
 279
 280         # only necessary if the circ objects have not been built yet
 281
 282         _grab_patron_standings($session);
 283         _grab_patron_profiles($session);
 284
 285
 286         my $copy = _grab_copy_by_barcode($session, $barcode_string);
 287         if(!$copy) { return NO_COPY; }
 288
 289         my $patron = _grab_user($session, $patron_id);
 290
 291         $copy->status( $copy->status->name );
 292         $circ_objects->{copy} = $copy;
 293
 294         $patron->standing($patron_standings->{$patron->standing()});
 295         $patron->profile( $patron_profiles->{$patron->profile});
 296         $circ_objects->{patron} = $patron;
 297         $circ_objects->{standings} = $patron_standings;
 298
 299         #$circ_objects->{title} = $title_req->gather(1);
 300         $circ_objects->{title} = _grab_title_by_copy($session, $circ_objects->{copy}->id);
 301         $cache_handle->put_cache( $cache_key, $circ_objects, 30 );
 302
 303         $stash = Template::Stash->new(
 304                         circ_objects                    => $circ_objects,
 305                         result                                  => [],
 306                         target_copy_status      => 1,
 307                         );
 308 }
 309
 310
 311
 312 sub run_script {
 313
 314         my $result;
 315
 316         my $template = Template->new(
 317                 {
 318                         STASH                   => $stash,
 319                         ABSOLUTE                => 1,
 320                         OUTPUT          => \$result,
 321                 }
 322         );
 323
 324         my $status = $template->process($circ_script);
 325
 326         if(!$status) {
 327                 throw OpenSRF::EX::ERROR
 328                         ("Error processing circ script " .  $template->error());
 329         }
 330
 331         warn "Script result: $result\n";
 332 }
 333
 334
 335
 336
 337 __PACKAGE__->register_method(
 338         method  => "permit_circ",
 339         api_name        => "open-ils.circ.permit_checkout",
 340 );
 341
 342 sub permit_circ {
 343         my( $self, $client, $user_session, $barcode, $user_id, $outstanding_count ) = @_;
 344
 345         my $renew = 0;
 346         if(defined($outstanding_count) && $outstanding_count eq "renew") {
 347                 $renew = 1;
 348                 $outstanding_count = 0;
 349         } else { $outstanding_count ||= 0; }
 350
 351
 352         my $session     = OpenSRF::AppSession->create("open-ils.storage");
 353
 354         # collect items necessary for circ calculation
 355         my $status = gather_circ_objects( $session, $barcode, $user_id );
 356
 357         if( $status == NO_COPY ) {
 358                 return { record => undef,
 359                         status => NO_COPY,
 360                         text => "No copy available with barcode $barcode"
 361                 };
 362         }
 363
 364         $stash->set("run_block", $permission_script);
 365
 366         # grab the number of copies checked out by the patron as
 367         # well as the total fines
 368         my $summary_req = $session->request(
 369                 "open-ils.storage.action.circulation.patron_summary",
 370                 $stash->get("circ_objects")->{patron}->id );
 371         my $summary = $summary_req->gather(1);
 372
 373         $summary->[0] ||= 0;
 374         $summary->[1] ||= 0.0;
 375
 376         $stash->set("patron_copies", $summary->[0]  + $outstanding_count );
 377         $stash->set("patron_fines", $summary->[1] );
 378         $stash->set("renew", 1) if $renew;
 379
 380         # run the permissibility script
 381         run_script();
 382
 383
 384         my $arr = $stash->get("result");
 385         return { status => $arr->[0], text => $arr->[1] };
 386
 387 }
 388
 389
 390
 391 __PACKAGE__->register_method(
 392         method  => "circulate",
 393         api_name        => "open-ils.circ.checkout.barcode",
 394 );
 395
 396 sub circulate {
 397         my( $self, $client, $user_session, $barcode, $patron, $isrenew, $numrenews ) = @_;
 398
 399
 400         my $session = $apputils->start_db_session();
 401
 402         gather_circ_objects( $session, $barcode, $patron );
 403
 404         # grab the copy statuses if we don't already have them
 405         if(!$copy_statuses) {
 406                 my $csreq = $session->request(
 407                         "open-ils.storage.direct.config.copy_status.retrieve.all.atomic" );
 408                 $copy_statuses = $csreq->gather(1);
 409         }
 410
 411         # put copy statuses into the stash
 412         $stash->set("copy_statuses", $copy_statuses );
 413
 414         my $copy = $circ_objects->{copy};
 415         my ($circ, $duration, $recurring, $max) =  run_circ_scripts($session);
 416
 417
 418         my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
 419                 gmtime(OpenSRF::Utils->interval_to_seconds($circ->duration) + int(time()));
 420         $year += 1900; $mon += 1;
 421         my $due_date = sprintf(
 422         '%s-%0.2d-%0.2dT%s:%0.2d:%0.s2-00',
 423         $year, $mon, $mday, $hour, $min, $sec);
 424
 425         warn "Setting due date to $due_date\n";
 426         $circ->due_date($due_date);
 427
 428         if($isrenew) {
 429                 warn "Renewing circ.... ".$circ->id ." and setting num renews to " . $numrenews - 1 . "\n";
 430                 $circ->renewal(1);
 431                 $circ->clear_id;
 432                 $circ->renewal_remaining($numrenews - 1);
 433         }
 434
 435
 436         # commit new circ object to db
 437         my $commit = $session->request(
 438                 "open-ils.storage.direct.action.circulation.create",
 439                 $circ );
 440         my $id = $commit->gather(1);
 441
 442         if(!$id) {
 443                 throw OpenSRF::EX::ERROR
 444                         ("Error creating new circulation object");
 445         }
 446
 447         # update the copy with the new circ
 448         $copy->status( $stash->get("target_copy_status") );
 449         $copy->location( $copy->location->id );
 450         $copy->circ_lib( $copy->circ_lib->id ); #XXX XXX needs to point to the lib that actually checked out the item (user->home_ou)?
 451
 452         # commit copy to db
 453         my $copy_update = $session->request(
 454                 "open-ils.storage.direct.asset.copy.update",
 455                 $copy );
 456         $copy_update->gather(1);
 457
 458         $apputils->commit_db_session($session);
 459
 460         # remove our circ object from the cache
 461         $cache_handle->delete_cache("circ_object_" . md5_hex($barcode, $patron));
 462
 463         # re-retrieve the the committed circ object
 464         $circ = $apputils->simple_scalar_request(
 465                 "open-ils.storage",
 466                 "open-ils.storage.direct.action.circulation.retrieve",
 467                 $id );
 468
 469
 470         # push the rules and due date into the circ object
 471         $circ->duration_rule($duration);
 472         $circ->max_fine_rule($max);
 473         $circ->recuring_fine_rule($recurring);
 474
 475         # turn the biblio record into a friendly object
 476         my $obj = $stash->get("circ_objects");
 477         my $u = OpenILS::Utils::ModsParser->new();
 478         $u->start_mods_batch( $circ_objects->{title}->marc() );
 479         my $mods = $u->finish_mods_batch();
 480
 481
 482         return { circ => $circ, copy => $copy, record => $mods };
 483
 484 }
 485
 486
 487
 488 # runs the duration, recurring_fines, and max_fines scripts.
 489 # builds the new circ object based on the rules returned from
 490 # these scripts.
 491 # returns (circ, duration_rule, recurring_fines_rule, max_fines_rule)
 492 sub run_circ_scripts {
 493         my $session = shift;
 494
 495         # go through all of the scripts and process
 496         # each script returns
 497         # [ rule_name, level (appropriate to the script) ]
 498         $stash->set("result", [] );
 499         $stash->set("run_block", $duration_script);
 500         run_script();
 501         my $duration_rule = $stash->get("result");
 502
 503         $stash->set("run_block", $recurring_fines_script);
 504         $stash->set("result", [] );
 505         run_script();
 506         my $rec_fines_rule = $stash->get("result");
 507
 508         $stash->set("run_block", $max_fines_script);
 509         $stash->set("result", [] );
 510         run_script();
 511         my $max_fines_rule = $stash->get("result");
 512
 513         my $obj = $stash->get("circ_objects");
 514
 515         # ----------------------------------------------------------
 516         # find the rules objects based on the rule names returned from
 517         # the various scripts.
 518         my $dur_req = $session->request(
 519                 "open-ils.storage.direct.config.rules.circ_duration.search.name.atomic",
 520                 $duration_rule->[0] );
 521
 522         my $rec_req = $session->request(
 523                 "open-ils.storage.direct.config.rules.recuring_fine.search.name.atomic",
 524                 $rec_fines_rule->[0] );
 525
 526         my $max_req = $session->request(
 527                 "open-ils.storage.direct.config.rules.max_fine.search.name.atomic",
 528                 $max_fines_rule->[0] );
 529
 530         my $duration    = $dur_req->gather(1)->[0];
 531         my $recurring   = $rec_req->gather(1)->[0];
 532         my $max                 = $max_req->gather(1)->[0];
 533
 534         my $copy = $circ_objects->{copy};
 535
 536         use Data::Dumper;
 537         warn "Building a new circulation object with\n".
 538                 "=> copy "                              . Dumper($copy) .
 539                 "=> duration_rule "     . Dumper($duration_rule) .
 540                 "=> rec_files_rule " . Dumper($rec_fines_rule) .
 541                 "=> duration "                  . Dumper($duration) .
 542                 "=> recurring "         . Dumper($recurring) .
 543                 "=> max "                               . Dumper($max);
 544
 545
 546         # build the new circ object
 547         my $circ =  build_circ_object($session, $copy, $duration_rule->[1],
 548                         $rec_fines_rule->[1], $duration, $recurring, $max );
 549
 550         return ($circ, $duration, $recurring, $max);
 551
 552 }
 553
 554 # ------------------------------------------------------------------
 555 # Builds a new circ object
 556 # ------------------------------------------------------------------
 557 sub build_circ_object {
 558         my( $session, $copy, $dur_level, $rec_level,
 559                         $duration, $recurring, $max ) = @_;
 560
 561         my $circ = new Fieldmapper::action::circulation;
 562
 563         $circ->circ_lib( $copy->circ_lib->id() );
 564         if($dur_level == 1) {
 565                 $circ->duration( $duration->shrt );
 566         } elsif($dur_level == 2) {
 567                 $circ->duration( $duration->normal );
 568         } elsif($dur_level == 3) {
 569                 $circ->duration( $duration->extended );
 570         }
 571
 572         if($rec_level == 1) {
 573                 $circ->recuring_fine( $recurring->low );
 574         } elsif($rec_level == 2) {
 575                 $circ->recuring_fine( $recurring->normal );
 576         } elsif($rec_level == 3) {
 577                 $circ->recuring_fine( $recurring->high );
 578         }
 579
 580         $circ->duration_rule( $duration->name );
 581         $circ->recuring_fine_rule( $recurring->name );
 582         $circ->max_fine_rule( $max->name );
 583         $circ->max_fine( $max->amount );
 584
 585         $circ->fine_interval($recurring->recurance_interval);
 586         $circ->renewal_remaining( $duration->max_renewals );
 587         $circ->target_copy( $copy->id );
 588         $circ->usr( $circ_objects->{patron}->id );
 589
 590         return $circ;
 591
 592 }
 593
 594
 595 __PACKAGE__->register_method(
 596         method  => "checkin",
 597         api_name        => "open-ils.circ.checkin.barcode",
 598         notes           => <<"  NOTES");
 599         Checks in based on barcode
 600         Returns record, status, text, circ, copy, route_to
 601         'status' values:
 602                 0 = OK
 603                 1 = 'copy required to fulfil a hold'
 604         NOTES
 605
 606 sub checkin {
 607         my( $self, $client, $user_session, $barcode, $isrenewal ) = @_;
 608
 609         my $err;
 610         my $copy;
 611         my $circ;
 612
 613         my $transaction;
 614         my $user = $apputils->check_user_session($user_session);
 615
 616         try {
 617                 my $session = $apputils->start_db_session();
 618
 619                 warn "retrieving copy for checkin\n";
 620
 621                 if(!$shelving_locations) {
 622                         my $sh_req = $session->request(
 623                                 "open-ils.storage.direct.asset.copy_location.retrieve.all.atomic");
 624                         $shelving_locations = $sh_req->gather(1);
 625                         $shelving_locations =
 626                                 { map { (''.$_->id => $_->name) } @$shelving_locations };
 627                 }
 628
 629                 my $copy_req = $session->request(
 630                         "open-ils.storage.direct.asset.copy.search.barcode.atomic",
 631                         $barcode );
 632                 $copy = $copy_req->gather(1)->[0];
 633                 if(!$copy) {
 634                         $client->respond_complete(OpenILS::EX->new("UNKNOWN_BARCODE")->ex);
 635                 }
 636
 637
 638
 639                 $copy->status(0);
 640
 641                 # find circ's where the transaction is still open for the
 642                 # given copy.  should only be one.
 643                 warn "Retrieving circ for checkin\n";
 644                 my $circ_req = $session->request(
 645                         "open-ils.storage.direct.action.circulation.search.atomic",
 646                         { target_copy => $copy->id, xact_finish => undef } );
 647
 648                 $circ = $circ_req->gather(1)->[0];
 649
 650
 651                 if(!$circ) {
 652                         $err = "No circulation exists for the given barcode";
 653
 654                 } else {
 655
 656                         $transaction = $session->request(
 657                                 "open-ils.storage.direct.money.billable_transaction_summary.retrieve", $circ->id)->gather(1);
 658
 659                         warn "Checking in circ ". $circ->id . "\n";
 660
 661                         $circ->stop_fines("CHECKIN");
 662                         $circ->stop_fines("RENEW") if($isrenewal);
 663                         $circ->xact_finish("now") if($transaction->balance_owed <= 0 );
 664
 665                         my $cp_up = $session->request(
 666                                 "open-ils.storage.direct.asset.copy.update", $copy );
 667                         $cp_up->gather(1);
 668
 669                         my $ci_up = $session->request(
 670                                 "open-ils.storage.direct.action.circulation.update",
 671                                 $circ );
 672                         $ci_up->gather(1);
 673
 674                         $apputils->commit_db_session($session);
 675
 676                         warn "Checkin succeeded\n";
 677                 }
 678
 679         } catch Error with {
 680                 my $e = shift;
 681                 $err = "Error checking in: $e";
 682         };
 683
 684         if($err) {
 685
 686                 return { record => undef, status => -1, text => $err };
 687
 688         } else {
 689
 690                 my $status = "0";
 691                 my $status_text = "OK";
 692
 693                 # check to see if the copy is needed to fulfil a hold
 694                 my $r = $apputils->simple_scalar_request(
 695                         "open-ils.storage",
 696                         "open-ils.storage.direct.action.hold_copy_map.search.target_copy.atomic",
 697                         $copy->id );
 698
 699                 if(@$r != 0) {
 700                         if( $user->id ne $circ->usr ) {
 701                                 $status = "1";
 702                                 $status_text = "Copy needed to fulfill hold";
 703                         }
 704                 }
 705
 706                 my $record = $apputils->simple_scalar_request(
 707                         "open-ils.storage",
 708                         "open-ils.storage.fleshed.biblio.record_entry.retrieve_by_copy",
 709                         $copy->id() );
 710
 711                 my $u = OpenILS::Utils::ModsParser->new();
 712                 $u->start_mods_batch( $record->marc() );
 713                 my $mods = $u->finish_mods_batch();
 714
 715                 return {
 716                         record => $mods,
 717                         status => $status,
 718                         text => $status_text,
 719                         circ => $circ,
 720                         copy => $copy,
 721                         route_to => $shelving_locations->{$copy->location}
 722                 };
 723         }
 724
 725         return 1;
 726
 727 }
 728
 729
 730
 731
 732
 733
 734
 735
 736 # ------------------------------------------------------------------------------
 737 # RENEWALS
 738 # ------------------------------------------------------------------------------
 739
 740
 741 __PACKAGE__->register_method(
 742         method  => "renew",
 743         api_name        => "open-ils.circ.renew",
 744         notes           => <<"  NOTES");
 745         open-ils.circ.renew(login_session, circ_object);
 746         Renews the provided circulation.  login_session is the requestor of the
 747         renewal and if the logged in user is not the same as circ->usr, then
 748         the logged in user must have RENEW_CIRC permissions.
 749         NOTES
 750
 751 sub renew {
 752         my($self, $client, $login_session, $circ) = @_;
 753
 754         throw OpenSRF::EX::InvalidArg
 755                 ("open-ils.circ.renew no circ") unless defined($circ);
 756
 757         my $user = $apputils->check_user_session($login_session);
 758
 759         my $session = OpenSRF::AppSession->create("open-ils.storage");
 760         my $copy = _grab_copy_by_id($session, $circ->target_copy);
 761
 762         my $r = $session->request(
 763                 "open-ils.storage.direct.action.hold_copy_map.search.target_copy.atomic",
 764                 $copy->id )->gather(1);
 765
 766         if(@$r != 0) {
 767                 if( $user->id ne $circ->usr ) {
 768                         if($apputils->check_user_perms($user->id, $user->home_ou, "RENEW_HOLD_OVERRIDE")) {
 769                                 return OpenILS::Perm->new("RENEW_HOLD_OVERRIDE");
 770                         }
 771                 }
 772
 773                 return OpenILS::EX->new("COPY_NEEDED_FOR_HOLD")->ex;
 774         }
 775
 776
 777         if(!ref($circ)) {
 778                 $circ = $session->request(
 779                         "open-ils.storage.direct.action.circulation.retrieve", $circ )->gather(1);
 780         }
 781
 782         my $iid = $circ->id;
 783         warn "Attempting to renew circ " . $iid . "\n";
 784
 785         if($user->id ne $circ->usr) {
 786                 if($apputils->check_user_perms($user->id, $user->home_ou, "RENEW_CIRC")) {
 787                         return OpenILS::Perm->new("RENEW_CIRC");
 788                 }
 789         }
 790
 791         if($circ->renewal_remaining <= 0) {
 792                 return OpenILS::EX->new("MAX_RENEWALS_REACHED")->ex; }
 793
 794
 795
 796         # XXX XXX See if the copy this circ points to is needed to fulfill a hold!
 797         # XXX check overdue..?
 798
 799         my $checkin = $self->method_lookup("open-ils.circ.checkin.barcode");
 800         my ($status) = $checkin->run($login_session, $copy->barcode, 1);
 801         return $status if ($status->{status} ne "0");
 802         warn "Renewal checkin completed for $iid\n";
 803
 804         my $permit_checkout = $self->method_lookup("open-ils.circ.permit_checkout");
 805         ($status) = $permit_checkout->run($login_session, $copy->barcode, $circ->usr, "renew");
 806         return $status if($status->{status} ne "0");
 807         warn "Renewal permit checkout completed for $iid\n";
 808
 809         my $checkout = $self->method_lookup("open-ils.circ.checkout.barcode");
 810         ($status) = $checkout->run($login_session, $copy->barcode, $circ->usr, 1, $circ->renewal_remaining);
 811         warn "Renewal checkout completed for $iid\n";
 812         return $status;
 813
 814 }
 815
 816
 817
 818 1;