C4/Circulation.pm

   1 package C4::Circulation;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 # copyright 2010 BibLibre
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it
   9 # under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  20
  21 use Modern::Perl;
  22 use DateTime;
  23 use POSIX qw( floor );
  24 use Koha::DateUtils;
  25 use C4::Context;
  26 use C4::Stats;
  27 use C4::Reserves;
  28 use C4::Biblio;
  29 use C4::Items;
  30 use C4::Members;
  31 use C4::Accounts;
  32 use C4::ItemCirculationAlertPreference;
  33 use C4::Message;
  34 use C4::Debug;
  35 use C4::Log; # logaction
  36 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
  37 use C4::RotatingCollections qw(GetCollectionItemBranches);
  38 use Algorithm::CheckDigits;
  39
  40 use Data::Dumper;
  41 use Koha::Account;
  42 use Koha::AuthorisedValues;
  43 use Koha::Biblioitems;
  44 use Koha::DateUtils;
  45 use Koha::Calendar;
  46 use Koha::Checkouts;
  47 use Koha::Illrequests;
  48 use Koha::Items;
  49 use Koha::Patrons;
  50 use Koha::Patron::Debarments;
  51 use Koha::Database;
  52 use Koha::Libraries;
  53 use Koha::Account::Lines;
  54 use Koha::Holds;
  55 use Koha::Account::Lines;
  56 use Koha::Account::Offsets;
  57 use Koha::Config::SysPrefs;
  58 use Koha::Charges::Fees;
  59 use Koha::Util::SystemPreferences;
  60 use Koha::Checkouts::ReturnClaims;
  61 use Carp;
  62 use List::MoreUtils qw( uniq any );
  63 use Scalar::Util qw( looks_like_number );
  64 use Try::Tiny;
  65 use Date::Calc qw(
  66   Today
  67   Today_and_Now
  68   Add_Delta_YM
  69   Add_Delta_DHMS
  70   Date_to_Days
  71   Day_of_Week
  72   Add_Delta_Days
  73 );
  74 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  75
  76 BEGIN {
  77         require Exporter;
  78         @ISA    = qw(Exporter);
  79
  80         # FIXME subs that should probably be elsewhere
  81         push @EXPORT, qw(
  82                 &barcodedecode
  83         &LostItem
  84         &ReturnLostItem
  85         &GetPendingOnSiteCheckouts
  86         );
  87
  88         # subs to deal with issuing a book
  89         push @EXPORT, qw(
  90                 &CanBookBeIssued
  91                 &CanBookBeRenewed
  92                 &AddIssue
  93                 &AddRenewal
  94                 &GetRenewCount
  95         &GetSoonestRenewDate
  96         &GetLatestAutoRenewDate
  97                 &GetIssuingCharges
  98         &GetBranchBorrowerCircRule
  99         &GetBranchItemRule
 100                 &GetBiblioIssues
 101                 &GetOpenIssue
 102         &CheckIfIssuedToPatron
 103         &IsItemIssued
 104         GetTopIssues
 105         );
 106
 107         # subs to deal with returns
 108         push @EXPORT, qw(
 109                 &AddReturn
 110         &MarkIssueReturned
 111         );
 112
 113         # subs to deal with transfers
 114         push @EXPORT, qw(
 115                 &transferbook
 116                 &GetTransfers
 117                 &GetTransfersFromTo
 118                 &updateWrongTransfer
 119                 &DeleteTransfer
 120                 &IsBranchTransferAllowed
 121                 &CreateBranchTransferLimit
 122                 &DeleteBranchTransferLimits
 123         &TransferSlip
 124         );
 125
 126     # subs to deal with offline circulation
 127     push @EXPORT, qw(
 128       &GetOfflineOperations
 129       &GetOfflineOperation
 130       &AddOfflineOperation
 131       &DeleteOfflineOperation
 132       &ProcessOfflineOperation
 133     );
 134 }
 135
 136 =head1 NAME
 137
 138 C4::Circulation - Koha circulation module
 139
 140 =head1 SYNOPSIS
 141
 142 use C4::Circulation;
 143
 144 =head1 DESCRIPTION
 145
 146 The functions in this module deal with circulation, issues, and
 147 returns, as well as general information about the library.
 148 Also deals with inventory.
 149
 150 =head1 FUNCTIONS
 151
 152 =head2 barcodedecode
 153
 154   $str = &barcodedecode($barcode, [$filter]);
 155
 156 Generic filter function for barcode string.
 157 Called on every circ if the System Pref itemBarcodeInputFilter is set.
 158 Will do some manipulation of the barcode for systems that deliver a barcode
 159 to circulation.pl that differs from the barcode stored for the item.
 160 For proper functioning of this filter, calling the function on the
 161 correct barcode string (items.barcode) should return an unaltered barcode.
 162
 163 The optional $filter argument is to allow for testing or explicit
 164 behavior that ignores the System Pref.  Valid values are the same as the
 165 System Pref options.
 166
 167 =cut
 168
 169 # FIXME -- the &decode fcn below should be wrapped into this one.
 170 # FIXME -- these plugins should be moved out of Circulation.pm
 171 #
 172 sub barcodedecode {
 173     my ($barcode, $filter) = @_;
 174     my $branch = C4::Context::mybranch();
 175     $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
 176     $filter or return $barcode;     # ensure filter is defined, else return untouched barcode
 177         if ($filter eq 'whitespace') {
 178                 $barcode =~ s/\s//g;
 179         } elsif ($filter eq 'cuecat') {
 180                 chomp($barcode);
 181             my @fields = split( /\./, $barcode );
 182             my @results = map( decode($_), @fields[ 1 .. $#fields ] );
 183             ($#results == 2) and return $results[2];
 184         } elsif ($filter eq 'T-prefix') {
 185                 if ($barcode =~ /^[Tt](\d)/) {
 186                         (defined($1) and $1 eq '0') and return $barcode;
 187             $barcode = substr($barcode, 2) + 0;     # FIXME: probably should be substr($barcode, 1)
 188                 }
 189         return sprintf("T%07d", $barcode);
 190         # FIXME: $barcode could be "T1", causing warning: substr outside of string
 191         # Why drop the nonzero digit after the T?
 192         # Why pass non-digits (or empty string) to "T%07d"?
 193         } elsif ($filter eq 'libsuite8') {
 194                 unless($barcode =~ m/^($branch)-/i){    #if barcode starts with branch code its in Koha style. Skip it.
 195                         if($barcode =~ m/^(\d)/i){      #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
 196                                 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
 197                         }else{
 198                                 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
 199                         }
 200                 }
 201     } elsif ($filter eq 'EAN13') {
 202         my $ean = CheckDigits('ean');
 203         if ( $ean->is_valid($barcode) ) {
 204             #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
 205             $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
 206         } else {
 207             warn "# [$barcode] not valid EAN-13/UPC-A\n";
 208         }
 209         }
 210     return $barcode;    # return barcode, modified or not
 211 }
 212
 213 =head2 decode
 214
 215   $str = &decode($chunk);
 216
 217 Decodes a segment of a string emitted by a CueCat barcode scanner and
 218 returns it.
 219
 220 FIXME: Should be replaced with Barcode::Cuecat from CPAN
 221 or Javascript based decoding on the client side.
 222
 223 =cut
 224
 225 sub decode {
 226     my ($encoded) = @_;
 227     my $seq =
 228       'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
 229     my @s = map { index( $seq, $_ ); } split( //, $encoded );
 230     my $l = ( $#s + 1 ) % 4;
 231     if ($l) {
 232         if ( $l == 1 ) {
 233             # warn "Error: Cuecat decode parsing failed!";
 234             return;
 235         }
 236         $l = 4 - $l;
 237         $#s += $l;
 238     }
 239     my $r = '';
 240     while ( $#s >= 0 ) {
 241         my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
 242         $r .=
 243             chr( ( $n >> 16 ) ^ 67 )
 244          .chr( ( $n >> 8 & 255 ) ^ 67 )
 245          .chr( ( $n & 255 ) ^ 67 );
 246         @s = @s[ 4 .. $#s ];
 247     }
 248     $r = substr( $r, 0, length($r) - $l );
 249     return $r;
 250 }
 251
 252 =head2 transferbook
 253
 254   ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
 255                                             $barcode, $ignore_reserves, $trigger);
 256
 257 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
 258
 259 C<$newbranch> is the code for the branch to which the item should be transferred.
 260
 261 C<$barcode> is the barcode of the item to be transferred.
 262
 263 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
 264 Otherwise, if an item is reserved, the transfer fails.
 265
 266 C<$trigger> is the enum value for what triggered the transfer.
 267
 268 Returns three values:
 269
 270 =over
 271
 272 =item $dotransfer
 273
 274 is true if the transfer was successful.
 275
 276 =item $messages
 277
 278 is a reference-to-hash which may have any of the following keys:
 279
 280 =over
 281
 282 =item C<BadBarcode>
 283
 284 There is no item in the catalog with the given barcode. The value is C<$barcode>.
 285
 286 =item C<DestinationEqualsHolding>
 287
 288 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
 289
 290 =item C<WasReturned>
 291
 292 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
 293
 294 =item C<ResFound>
 295
 296 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
 297
 298 =item C<WasTransferred>
 299
 300 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
 301
 302 =back
 303
 304 =back
 305
 306 =cut
 307
 308 sub transferbook {
 309     my ( $tbr, $barcode, $ignoreRs, $trigger ) = @_;
 310     my $messages;
 311     my $dotransfer      = 1;
 312     my $item = Koha::Items->find( { barcode => $barcode } );
 313
 314     # bad barcode..
 315     unless ( $item ) {
 316         $messages->{'BadBarcode'} = $barcode;
 317         $dotransfer = 0;
 318         return ( $dotransfer, $messages );
 319     }
 320
 321     my $itemnumber = $item->itemnumber;
 322     # get branches of book...
 323     my $hbr = $item->homebranch;
 324     my $fbr = $item->holdingbranch;
 325
 326     # if using Branch Transfer Limits
 327     if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
 328         my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
 329         if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
 330             if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
 331                 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
 332                 $dotransfer = 0;
 333             }
 334         } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
 335             $messages->{'NotAllowed'} = $tbr . "::" . $code;
 336             $dotransfer = 0;
 337         }
 338     }
 339
 340     # can't transfer book if is already there....
 341     if ( $fbr eq $tbr ) {
 342         $messages->{'DestinationEqualsHolding'} = 1;
 343         $dotransfer = 0;
 344     }
 345
 346     # check if it is still issued to someone, return it...
 347     my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
 348     if ( $issue ) {
 349         AddReturn( $barcode, $fbr );
 350         $messages->{'WasReturned'} = $issue->borrowernumber;
 351     }
 352
 353     # find reserves.....
 354     # That'll save a database query.
 355     my ( $resfound, $resrec, undef ) =
 356       CheckReserves( $itemnumber );
 357     if ( $resfound and not $ignoreRs ) {
 358         $resrec->{'ResFound'} = $resfound;
 359         $messages->{'ResFound'} = $resrec;
 360         $dotransfer = 1;
 361     }
 362
 363     #actually do the transfer....
 364     if ($dotransfer) {
 365         ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
 366
 367         # don't need to update MARC anymore, we do it in batch now
 368         $messages->{'WasTransfered'} = 1;
 369
 370     }
 371     ModDateLastSeen( $itemnumber );
 372     return ( $dotransfer, $messages );
 373 }
 374
 375
 376 sub TooMany {
 377     my $borrower        = shift;
 378     my $item_object = shift;
 379     my $params = shift;
 380     my $onsite_checkout = $params->{onsite_checkout} || 0;
 381     my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
 382     my $cat_borrower    = $borrower->{'categorycode'};
 383     my $dbh             = C4::Context->dbh;
 384         my $branch;
 385         # Get which branchcode we need
 386     $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
 387     my $type = $item_object->effective_itemtype;
 388
 389     # given branch, patron category, and item type, determine
 390     # applicable issuing rule
 391     my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
 392         {
 393             categorycode => $cat_borrower,
 394             itemtype     => $type,
 395             branchcode   => $branch,
 396             rule_name    => 'maxissueqty',
 397         }
 398     );
 399     my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
 400         {
 401             categorycode => $cat_borrower,
 402             itemtype     => $type,
 403             branchcode   => $branch,
 404             rule_name    => 'maxonsiteissueqty',
 405         }
 406     );
 407
 408
 409     # if a rule is found and has a loan limit set, count
 410     # how many loans the patron already has that meet that
 411     # rule
 412     if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne '') {
 413         my @bind_params;
 414         my $count_query = q|
 415             SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
 416             FROM issues
 417             JOIN items USING (itemnumber)
 418         |;
 419
 420         my $rule_itemtype = $maxissueqty_rule->itemtype;
 421         unless ($rule_itemtype) {
 422             # matching rule has the default item type, so count only
 423             # those existing loans that don't fall under a more
 424             # specific rule
 425             if (C4::Context->preference('item-level_itypes')) {
 426                 $count_query .= " WHERE items.itype NOT IN (
 427                                     SELECT itemtype FROM circulation_rules
 428                                     WHERE branchcode = ?
 429                                     AND   (categorycode = ? OR categorycode = ?)
 430                                     AND   itemtype IS NOT NULL
 431                                     AND   rule_name = 'maxissueqty'
 432                                   ) ";
 433             } else {
 434                 $count_query .= " JOIN  biblioitems USING (biblionumber)
 435                                   WHERE biblioitems.itemtype NOT IN (
 436                                     SELECT itemtype FROM circulation_rules
 437                                     WHERE branchcode = ?
 438                                     AND   (categorycode = ? OR categorycode = ?)
 439                                     AND   itemtype IS NOT NULL
 440                                     AND   rule_name = 'maxissueqty'
 441                                   ) ";
 442             }
 443             push @bind_params, $maxissueqty_rule->branchcode;
 444             push @bind_params, $maxissueqty_rule->categorycode;
 445             push @bind_params, $cat_borrower;
 446         } else {
 447             # rule has specific item type, so count loans of that
 448             # specific item type
 449             if (C4::Context->preference('item-level_itypes')) {
 450                 $count_query .= " WHERE items.itype = ? ";
 451             } else {
 452                 $count_query .= " JOIN  biblioitems USING (biblionumber)
 453                                   WHERE biblioitems.itemtype= ? ";
 454             }
 455             push @bind_params, $type;
 456         }
 457
 458         $count_query .= " AND borrowernumber = ? ";
 459         push @bind_params, $borrower->{'borrowernumber'};
 460         my $rule_branch = $maxissueqty_rule->branchcode;
 461         if ($rule_branch) {
 462             if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
 463                 $count_query .= " AND issues.branchcode = ? ";
 464                 push @bind_params, $rule_branch;
 465             } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
 466                 ; # if branch is the patron's home branch, then count all loans by patron
 467             } else {
 468                 $count_query .= " AND items.homebranch = ? ";
 469                 push @bind_params, $rule_branch;
 470             }
 471         }
 472
 473         my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
 474
 475         my $max_checkouts_allowed = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
 476         my $max_onsite_checkouts_allowed = $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef;
 477
 478         if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
 479             if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed )  {
 480                 return {
 481                     reason => 'TOO_MANY_ONSITE_CHECKOUTS',
 482                     count => $onsite_checkout_count,
 483                     max_allowed => $max_onsite_checkouts_allowed,
 484                 }
 485             }
 486         }
 487         if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
 488             my $delta = $switch_onsite_checkout ? 1 : 0;
 489             if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
 490                 return {
 491                     reason => 'TOO_MANY_CHECKOUTS',
 492                     count => $checkout_count,
 493                     max_allowed => $max_checkouts_allowed,
 494                 };
 495             }
 496         } elsif ( not $onsite_checkout ) {
 497             if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )  {
 498                 return {
 499                     reason => 'TOO_MANY_CHECKOUTS',
 500                     count => $checkout_count - $onsite_checkout_count,
 501                     max_allowed => $max_checkouts_allowed,
 502                 };
 503             }
 504         }
 505     }
 506
 507     # Now count total loans against the limit for the branch
 508     my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
 509     if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
 510         my @bind_params = ();
 511         my $branch_count_query = q|
 512             SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
 513             FROM issues
 514             JOIN items USING (itemnumber)
 515             WHERE borrowernumber = ?
 516         |;
 517         push @bind_params, $borrower->{borrowernumber};
 518
 519         if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
 520             $branch_count_query .= " AND issues.branchcode = ? ";
 521             push @bind_params, $branch;
 522         } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
 523             ; # if branch is the patron's home branch, then count all loans by patron
 524         } else {
 525             $branch_count_query .= " AND items.homebranch = ? ";
 526             push @bind_params, $branch;
 527         }
 528         my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
 529         my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
 530         my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty};
 531
 532         if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
 533             if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed )  {
 534                 return {
 535                     reason => 'TOO_MANY_ONSITE_CHECKOUTS',
 536                     count => $onsite_checkout_count,
 537                     max_allowed => $max_onsite_checkouts_allowed,
 538                 }
 539             }
 540         }
 541         if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
 542             my $delta = $switch_onsite_checkout ? 1 : 0;
 543             if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
 544                 return {
 545                     reason => 'TOO_MANY_CHECKOUTS',
 546                     count => $checkout_count,
 547                     max_allowed => $max_checkouts_allowed,
 548                 };
 549             }
 550         } elsif ( not $onsite_checkout ) {
 551             if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )  {
 552                 return {
 553                     reason => 'TOO_MANY_CHECKOUTS',
 554                     count => $checkout_count - $onsite_checkout_count,
 555                     max_allowed => $max_checkouts_allowed,
 556                 };
 557             }
 558         }
 559     }
 560
 561     if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
 562         return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
 563     }
 564
 565     # OK, the patron can issue !!!
 566     return;
 567 }
 568
 569 =head2 CanBookBeIssued
 570
 571   ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) =  CanBookBeIssued( $patron,
 572                       $barcode, $duedate, $inprocess, $ignore_reserves, $params );
 573
 574 Check if a book can be issued.
 575
 576 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
 577
 578 IMPORTANT: The assumption by users of this routine is that causes blocking
 579 the issue are keyed by uppercase labels and other returned
 580 data is keyed in lower case!
 581
 582 =over 4
 583
 584 =item C<$patron> is a Koha::Patron
 585
 586 =item C<$barcode> is the bar code of the book being issued.
 587
 588 =item C<$duedates> is a DateTime object.
 589
 590 =item C<$inprocess> boolean switch
 591
 592 =item C<$ignore_reserves> boolean switch
 593
 594 =item C<$params> Hashref of additional parameters
 595
 596 Available keys:
 597     override_high_holds - Ignore high holds
 598     onsite_checkout     - Checkout is an onsite checkout that will not leave the library
 599
 600 =back
 601
 602 Returns :
 603
 604 =over 4
 605
 606 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
 607 Possible values are :
 608
 609 =back
 610
 611 =head3 INVALID_DATE
 612
 613 sticky due date is invalid
 614
 615 =head3 GNA
 616
 617 borrower gone with no address
 618
 619 =head3 CARD_LOST
 620
 621 borrower declared it's card lost
 622
 623 =head3 DEBARRED
 624
 625 borrower debarred
 626
 627 =head3 UNKNOWN_BARCODE
 628
 629 barcode unknown
 630
 631 =head3 NOT_FOR_LOAN
 632
 633 item is not for loan
 634
 635 =head3 WTHDRAWN
 636
 637 item withdrawn.
 638
 639 =head3 RESTRICTED
 640
 641 item is restricted (set by ??)
 642
 643 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
 644 could be prevented, but ones that can be overriden by the operator.
 645
 646 Possible values are :
 647
 648 =head3 DEBT
 649
 650 borrower has debts.
 651
 652 =head3 RENEW_ISSUE
 653
 654 renewing, not issuing
 655
 656 =head3 ISSUED_TO_ANOTHER
 657
 658 issued to someone else.
 659
 660 =head3 RESERVED
 661
 662 reserved for someone else.
 663
 664 =head3 INVALID_DATE
 665
 666 sticky due date is invalid or due date in the past
 667
 668 =head3 TOO_MANY
 669
 670 if the borrower borrows to much things
 671
 672 =cut
 673
 674 sub CanBookBeIssued {
 675     my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
 676     my %needsconfirmation;    # filled with problems that needs confirmations
 677     my %issuingimpossible;    # filled with problems that causes the issue to be IMPOSSIBLE
 678     my %alerts;               # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
 679     my %messages;             # filled with information messages that should be displayed.
 680
 681     my $onsite_checkout     = $params->{onsite_checkout}     || 0;
 682     my $override_high_holds = $params->{override_high_holds} || 0;
 683
 684     my $item_object = Koha::Items->find({barcode => $barcode });
 685
 686     # MANDATORY CHECKS - unless item exists, nothing else matters
 687     unless ( $item_object ) {
 688         $issuingimpossible{UNKNOWN_BARCODE} = 1;
 689     }
 690     return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
 691
 692     my $item_unblessed = $item_object->unblessed; # Transition...
 693     my $issue = $item_object->checkout;
 694     my $biblio = $item_object->biblio;
 695
 696     my $biblioitem = $biblio->biblioitem;
 697     my $effective_itemtype = $item_object->effective_itemtype;
 698     my $dbh             = C4::Context->dbh;
 699     my $patron_unblessed = $patron->unblessed;
 700
 701     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
 702     #
 703     # DUE DATE is OK ? -- should already have checked.
 704     #
 705     if ($duedate && ref $duedate ne 'DateTime') {
 706         $duedate = dt_from_string($duedate);
 707     }
 708     my $now = dt_from_string();
 709     unless ( $duedate ) {
 710         my $issuedate = $now->clone();
 711
 712         $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
 713
 714         # Offline circ calls AddIssue directly, doesn't run through here
 715         #  So issuingimpossible should be ok.
 716     }
 717
 718     my $fees = Koha::Charges::Fees->new(
 719         {
 720             patron    => $patron,
 721             library   => $circ_library,
 722             item      => $item_object,
 723             to_date   => $duedate,
 724         }
 725     );
 726
 727     if ($duedate) {
 728         my $today = $now->clone();
 729         $today->truncate( to => 'minute');
 730         if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
 731             $needsconfirmation{INVALID_DATE} = output_pref($duedate);
 732         }
 733     } else {
 734             $issuingimpossible{INVALID_DATE} = output_pref($duedate);
 735     }
 736
 737     #
 738     # BORROWER STATUS
 739     #
 740     if ( $patron->category->category_type eq 'X' && (  $item_object->barcode  )) {
 741         # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1  .
 742         &UpdateStats({
 743                      branch => C4::Context->userenv->{'branch'},
 744                      type => 'localuse',
 745                      itemnumber => $item_object->itemnumber,
 746                      itemtype => $effective_itemtype,
 747                      borrowernumber => $patron->borrowernumber,
 748                      ccode => $item_object->ccode}
 749                     );
 750         ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
 751         return( { STATS => 1 }, {});
 752     }
 753
 754     if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
 755         $issuingimpossible{GNA} = 1;
 756     }
 757
 758     if ( $patron->lost && $patron->lost == 1 ) {
 759         $issuingimpossible{CARD_LOST} = 1;
 760     }
 761     if ( $patron->is_debarred ) {
 762         $issuingimpossible{DEBARRED} = 1;
 763     }
 764
 765     if ( $patron->is_expired ) {
 766         $issuingimpossible{EXPIRED} = 1;
 767     }
 768
 769     #
 770     # BORROWER STATUS
 771     #
 772
 773     # DEBTS
 774     my $account = $patron->account;
 775     my $balance = $account->balance;
 776     my $non_issues_charges = $account->non_issues_charges;
 777     my $other_charges = $balance - $non_issues_charges;
 778
 779     my $amountlimit = C4::Context->preference("noissuescharge");
 780     my $allowfineoverride = C4::Context->preference("AllowFineOverride");
 781     my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
 782
 783     # Check the debt of this patrons guarantees
 784     my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
 785     $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
 786     if ( defined $no_issues_charge_guarantees ) {
 787         my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
 788         my $guarantees_non_issues_charges;
 789         foreach my $g ( @guarantees ) {
 790             $guarantees_non_issues_charges += $g->account->non_issues_charges;
 791         }
 792
 793         if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
 794             $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
 795         } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
 796             $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
 797         } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
 798             $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
 799         }
 800     }
 801
 802     if ( C4::Context->preference("IssuingInProcess") ) {
 803         if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
 804             $issuingimpossible{DEBT} = $non_issues_charges;
 805         } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
 806             $needsconfirmation{DEBT} = $non_issues_charges;
 807         } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
 808             $needsconfirmation{DEBT} = $non_issues_charges;
 809         }
 810     }
 811     else {
 812         if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
 813             $needsconfirmation{DEBT} = $non_issues_charges;
 814         } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
 815             $issuingimpossible{DEBT} = $non_issues_charges;
 816         } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
 817             $needsconfirmation{DEBT} = $non_issues_charges;
 818         }
 819     }
 820
 821     if ($balance > 0 && $other_charges > 0) {
 822         $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
 823     }
 824
 825     $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
 826     $patron_unblessed = $patron->unblessed;
 827
 828     if ( my $debarred_date = $patron->is_debarred ) {
 829          # patron has accrued fine days or has a restriction. $count is a date
 830         if ($debarred_date eq '9999-12-31') {
 831             $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
 832         }
 833         else {
 834             $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
 835         }
 836     } elsif ( my $num_overdues = $patron->has_overdues ) {
 837         ## patron has outstanding overdue loans
 838         if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
 839             $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
 840         }
 841         elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
 842             $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
 843         }
 844     }
 845
 846     #
 847     # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
 848     #
 849     if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
 850
 851         # Already issued to current borrower.
 852         # If it is an on-site checkout if it can be switched to a normal checkout
 853         # or ask whether the loan should be renewed
 854
 855         if ( $issue->onsite_checkout
 856                 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
 857             $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
 858         } else {
 859             my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
 860                 $patron->borrowernumber,
 861                 $item_object->itemnumber,
 862             );
 863             if ( $CanBookBeRenewed == 0 ) {    # no more renewals allowed
 864                 if ( $renewerror eq 'onsite_checkout' ) {
 865                     $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
 866                 }
 867                 else {
 868                     $issuingimpossible{NO_MORE_RENEWALS} = 1;
 869                 }
 870             }
 871             else {
 872                 $needsconfirmation{RENEW_ISSUE} = 1;
 873             }
 874         }
 875     }
 876     elsif ( $issue ) {
 877
 878         # issued to someone else
 879
 880         my $patron = Koha::Patrons->find( $issue->borrowernumber );
 881
 882         my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
 883
 884         unless ( $can_be_returned ) {
 885             $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
 886             $issuingimpossible{branch_to_return} = $message;
 887         } else {
 888             if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
 889                 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
 890             } else {
 891             $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
 892             $needsconfirmation{issued_firstname} = $patron->firstname;
 893             $needsconfirmation{issued_surname} = $patron->surname;
 894             $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
 895             $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
 896             }
 897         }
 898     }
 899
 900     # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
 901     #
 902     my $switch_onsite_checkout = (
 903           C4::Context->preference('SwitchOnSiteCheckouts')
 904       and $issue
 905       and $issue->onsite_checkout
 906       and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
 907     my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
 908     # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
 909     if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
 910         if ( $toomany->{max_allowed} == 0 ) {
 911             $needsconfirmation{PATRON_CANT} = 1;
 912         }
 913         if ( C4::Context->preference("AllowTooManyOverride") ) {
 914             $needsconfirmation{TOO_MANY} = $toomany->{reason};
 915             $needsconfirmation{current_loan_count} = $toomany->{count};
 916             $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
 917         } else {
 918             $issuingimpossible{TOO_MANY} = $toomany->{reason};
 919             $issuingimpossible{current_loan_count} = $toomany->{count};
 920             $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
 921         }
 922     }
 923
 924     #
 925     # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
 926     #
 927     $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
 928     my $wants_check = $patron->wants_check_for_previous_checkout;
 929     $needsconfirmation{PREVISSUE} = 1
 930         if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
 931
 932     #
 933     # ITEM CHECKING
 934     #
 935     if ( $item_object->notforloan )
 936     {
 937         if(!C4::Context->preference("AllowNotForLoanOverride")){
 938             $issuingimpossible{NOT_FOR_LOAN} = 1;
 939             $issuingimpossible{item_notforloan} = $item_object->notforloan;
 940         }else{
 941             $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
 942             $needsconfirmation{item_notforloan} = $item_object->notforloan;
 943         }
 944     }
 945     else {
 946         # we have to check itemtypes.notforloan also
 947         if (C4::Context->preference('item-level_itypes')){
 948             # this should probably be a subroutine
 949             my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
 950             $sth->execute($effective_itemtype);
 951             my $notforloan=$sth->fetchrow_hashref();
 952             if ($notforloan->{'notforloan'}) {
 953                 if (!C4::Context->preference("AllowNotForLoanOverride")) {
 954                     $issuingimpossible{NOT_FOR_LOAN} = 1;
 955                     $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
 956                 } else {
 957                     $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
 958                     $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
 959                 }
 960             }
 961         }
 962         else {
 963             my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
 964             if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
 965                 if (!C4::Context->preference("AllowNotForLoanOverride")) {
 966                     $issuingimpossible{NOT_FOR_LOAN} = 1;
 967                     $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
 968                 } else {
 969                     $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
 970                     $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
 971                 }
 972             }
 973         }
 974     }
 975     if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
 976     {
 977         $issuingimpossible{WTHDRAWN} = 1;
 978     }
 979     if (   $item_object->restricted
 980         && $item_object->restricted == 1 )
 981     {
 982         $issuingimpossible{RESTRICTED} = 1;
 983     }
 984     if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
 985         my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
 986         my $code = $av->count ? $av->next->lib : '';
 987         $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
 988         $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
 989     }
 990     if ( C4::Context->preference("IndependentBranches") ) {
 991         my $userenv = C4::Context->userenv;
 992         unless ( C4::Context->IsSuperLibrarian() ) {
 993             my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
 994             if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
 995                 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
 996                 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
 997             }
 998             $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
 999               if ( $patron->branchcode ne $userenv->{branch} );
1000         }
1001     }
1002
1003     #
1004     # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1005     #
1006     my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1007     if ($rentalConfirmation) {
1008         my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1009
1010         my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1011         if ($itemtype_object) {
1012             my $accumulate_charge = $fees->accumulate_rentalcharge();
1013             if ( $accumulate_charge > 0 ) {
1014                 $rentalCharge += $accumulate_charge;
1015             }
1016         }
1017
1018         if ( $rentalCharge > 0 ) {
1019             $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1020         }
1021     }
1022
1023     unless ( $ignore_reserves ) {
1024         # See if the item is on reserve.
1025         my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1026         if ($restype) {
1027             my $resbor = $res->{'borrowernumber'};
1028             if ( $resbor ne $patron->borrowernumber ) {
1029                 my $patron = Koha::Patrons->find( $resbor );
1030                 if ( $restype eq "Waiting" )
1031                 {
1032                     # The item is on reserve and waiting, but has been
1033                     # reserved by some other patron.
1034                     $needsconfirmation{RESERVE_WAITING} = 1;
1035                     $needsconfirmation{'resfirstname'} = $patron->firstname;
1036                     $needsconfirmation{'ressurname'} = $patron->surname;
1037                     $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1038                     $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1039                     $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1040                     $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1041                     $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1042                 }
1043                 elsif ( $restype eq "Reserved" ) {
1044                     # The item is on reserve for someone else.
1045                     $needsconfirmation{RESERVED} = 1;
1046                     $needsconfirmation{'resfirstname'} = $patron->firstname;
1047                     $needsconfirmation{'ressurname'} = $patron->surname;
1048                     $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1049                     $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1050                     $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1051                     $needsconfirmation{'resreservedate'} = $res->{reservedate};
1052                     $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1053                 }
1054             }
1055         }
1056     }
1057
1058     ## CHECK AGE RESTRICTION
1059     my $agerestriction  = $biblioitem->agerestriction;
1060     my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1061     if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1062         if ( C4::Context->preference('AgeRestrictionOverride') ) {
1063             $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1064         }
1065         else {
1066             $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1067         }
1068     }
1069
1070     ## check for high holds decreasing loan period
1071     if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1072         my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1073
1074         if ( $check->{exceeded} ) {
1075             if ($override_high_holds) {
1076                 $alerts{HIGHHOLDS} = {
1077                     num_holds  => $check->{outstanding},
1078                     duration   => $check->{duration},
1079                     returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1080                 };
1081             }
1082             else {
1083                 $needsconfirmation{HIGHHOLDS} = {
1084                     num_holds  => $check->{outstanding},
1085                     duration   => $check->{duration},
1086                     returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1087                 };
1088             }
1089         }
1090     }
1091
1092     if (
1093         !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1094         # don't do the multiple loans per bib check if we've
1095         # already determined that we've got a loan on the same item
1096         !$issuingimpossible{NO_MORE_RENEWALS} &&
1097         !$needsconfirmation{RENEW_ISSUE}
1098     ) {
1099         # Check if borrower has already issued an item from the same biblio
1100         # Only if it's not a subscription
1101         my $biblionumber = $item_object->biblionumber;
1102         require C4::Serials;
1103         my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1104         unless ($is_a_subscription) {
1105             # FIXME Should be $patron->checkouts($args);
1106             my $checkouts = Koha::Checkouts->search(
1107                 {
1108                     borrowernumber => $patron->borrowernumber,
1109                     biblionumber   => $biblionumber,
1110                 },
1111                 {
1112                     join => 'item',
1113                 }
1114             );
1115             # if we get here, we don't already have a loan on this item,
1116             # so if there are any loans on this bib, ask for confirmation
1117             if ( $checkouts->count ) {
1118                 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1119             }
1120         }
1121     }
1122
1123     return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1124 }
1125
1126 =head2 CanBookBeReturned
1127
1128   ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1129
1130 Check whether the item can be returned to the provided branch
1131
1132 =over 4
1133
1134 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1135
1136 =item C<$branch> is the branchcode where the return is taking place
1137
1138 =back
1139
1140 Returns:
1141
1142 =over 4
1143
1144 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1145
1146 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1147
1148 =back
1149
1150 =cut
1151
1152 sub CanBookBeReturned {
1153   my ($item, $branch) = @_;
1154   my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1155
1156   # assume return is allowed to start
1157   my $allowed = 1;
1158   my $message;
1159
1160   # identify all cases where return is forbidden
1161   if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1162      $allowed = 0;
1163      $message = $item->{'homebranch'};
1164   } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1165      $allowed = 0;
1166      $message = $item->{'holdingbranch'};
1167   } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1168      $allowed = 0;
1169      $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1170   }
1171
1172   return ($allowed, $message);
1173 }
1174
1175 =head2 CheckHighHolds
1176
1177     used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1178     decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1179     has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1180
1181 =cut
1182
1183 sub checkHighHolds {
1184     my ( $item, $borrower ) = @_;
1185     my $branchcode = _GetCircControlBranch( $item, $borrower );
1186     my $item_object = Koha::Items->find( $item->{itemnumber} );
1187
1188     my $return_data = {
1189         exceeded    => 0,
1190         outstanding => 0,
1191         duration    => 0,
1192         due_date    => undef,
1193     };
1194
1195     my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1196
1197     if ( $holds->count() ) {
1198         $return_data->{outstanding} = $holds->count();
1199
1200         my $decreaseLoanHighHoldsControl        = C4::Context->preference('decreaseLoanHighHoldsControl');
1201         my $decreaseLoanHighHoldsValue          = C4::Context->preference('decreaseLoanHighHoldsValue');
1202         my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1203
1204         my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1205
1206         if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1207
1208             # static means just more than a given number of holds on the record
1209
1210             # If the number of holds is less than the threshold, we can stop here
1211             if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1212                 return $return_data;
1213             }
1214         }
1215         elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1216
1217             # dynamic means X more than the number of holdable items on the record
1218
1219             # let's get the items
1220             my @items = $holds->next()->biblio()->items()->as_list;
1221
1222             # Remove any items with status defined to be ignored even if the would not make item unholdable
1223             foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1224                 @items = grep { !$_->$status } @items;
1225             }
1226
1227             # Remove any items that are not holdable for this patron
1228             @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1229
1230             my $items_count = scalar @items;
1231
1232             my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1233
1234             # If the number of holds is less than the count of items we have
1235             # plus the number of holds allowed above that count, we can stop here
1236             if ( $holds->count() <= $threshold ) {
1237                 return $return_data;
1238             }
1239         }
1240
1241         my $issuedate = dt_from_string();
1242
1243         my $itype = $item_object->effective_itemtype;
1244         my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1245             {
1246                 categorycode => $borrower->{categorycode},
1247                 itemtype     => $itype,
1248                 branchcode   => $branchcode,
1249             }
1250         );
1251         my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1252
1253         my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1254
1255         my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1256
1257         my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1258         $reduced_datedue->set_hour($orig_due->hour);
1259         $reduced_datedue->set_minute($orig_due->minute);
1260         $reduced_datedue->truncate( to => 'minute' );
1261
1262         if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1263             $return_data->{exceeded} = 1;
1264             $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1265             $return_data->{due_date} = $reduced_datedue;
1266         }
1267     }
1268
1269     return $return_data;
1270 }
1271
1272 =head2 AddIssue
1273
1274   &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1275
1276 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1277
1278 =over 4
1279
1280 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1281
1282 =item C<$barcode> is the barcode of the item being issued.
1283
1284 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1285 Calculated if empty.
1286
1287 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1288
1289 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1290 Defaults to today.  Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1291
1292 AddIssue does the following things :
1293
1294   - step 01: check that there is a borrowernumber & a barcode provided
1295   - check for RENEWAL (book issued & being issued to the same patron)
1296       - renewal YES = Calculate Charge & renew
1297       - renewal NO  =
1298           * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1299           * RESERVE PLACED ?
1300               - fill reserve if reserve to this patron
1301               - cancel reserve or not, otherwise
1302           * TRANSFERT PENDING ?
1303               - complete the transfert
1304           * ISSUE THE BOOK
1305
1306 =back
1307
1308 =cut
1309
1310 sub AddIssue {
1311     my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1312
1313     my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1314     my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1315     my $auto_renew = $params && $params->{auto_renew};
1316     my $dbh          = C4::Context->dbh;
1317     my $barcodecheck = CheckValidBarcode($barcode);
1318
1319     my $issue;
1320
1321     if ( $datedue && ref $datedue ne 'DateTime' ) {
1322         $datedue = dt_from_string($datedue);
1323     }
1324
1325     # $issuedate defaults to today.
1326     if ( !defined $issuedate ) {
1327         $issuedate = dt_from_string();
1328     }
1329     else {
1330         if ( ref $issuedate ne 'DateTime' ) {
1331             $issuedate = dt_from_string($issuedate);
1332
1333         }
1334     }
1335
1336     # Stop here if the patron or barcode doesn't exist
1337     if ( $borrower && $barcode && $barcodecheck ) {
1338         # find which item we issue
1339         my $item_object = Koha::Items->find({ barcode => $barcode })
1340           or return;    # if we don't get an Item, abort.
1341         my $item_unblessed = $item_object->unblessed;
1342
1343         my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1344
1345         # get actual issuing if there is one
1346         my $actualissue = $item_object->checkout;
1347
1348         # check if we just renew the issue.
1349         if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1350                 and not $switch_onsite_checkout ) {
1351             $datedue = AddRenewal(
1352                 $borrower->{'borrowernumber'},
1353                 $item_object->itemnumber,
1354                 $branchcode,
1355                 $datedue,
1356                 $issuedate,    # here interpreted as the renewal date
1357             );
1358         }
1359         else {
1360             unless ($datedue) {
1361                 my $itype = $item_object->effective_itemtype;
1362                 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1363
1364             }
1365             $datedue->truncate( to => 'minute' );
1366
1367             my $patron = Koha::Patrons->find( $borrower );
1368             my $library = Koha::Libraries->find( $branchcode );
1369             my $fees = Koha::Charges::Fees->new(
1370                 {
1371                     patron    => $patron,
1372                     library   => $library,
1373                     item      => $item_object,
1374                     to_date   => $datedue,
1375                 }
1376             );
1377
1378             # it's NOT a renewal
1379             if ( $actualissue and not $switch_onsite_checkout ) {
1380                 # This book is currently on loan, but not to the person
1381                 # who wants to borrow it now. mark it returned before issuing to the new borrower
1382                 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1383                 return unless $allowed;
1384                 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1385             }
1386
1387             C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1388
1389             # Starting process for transfer job (checking transfert and validate it if we have one)
1390             my ($datesent) = GetTransfers( $item_object->itemnumber );
1391             if ($datesent) {
1392                 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1393                 my $sth = $dbh->prepare(
1394                     "UPDATE branchtransfers
1395                         SET datearrived = now(),
1396                         tobranch = ?,
1397                         comments = 'Forced branchtransfer'
1398                     WHERE itemnumber= ? AND datearrived IS NULL"
1399                 );
1400                 $sth->execute( C4::Context->userenv->{'branch'},
1401                     $item_object->itemnumber );
1402             }
1403
1404             # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1405             unless ($auto_renew) {
1406                 my $rule = Koha::CirculationRules->get_effective_rule(
1407                     {
1408                         categorycode => $borrower->{categorycode},
1409                         itemtype     => $item_object->effective_itemtype,
1410                         branchcode   => $branchcode,
1411                         rule_name    => 'auto_renew'
1412                     }
1413                 );
1414
1415                 $auto_renew = $rule->rule_value if $rule;
1416             }
1417
1418             # Record in the database the fact that the book was issued.
1419             unless ($datedue) {
1420                 my $itype = $item_object->effective_itemtype;
1421                 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1422
1423             }
1424             $datedue->truncate( to => 'minute' );
1425
1426             my $issue_attributes = {
1427                 borrowernumber  => $borrower->{'borrowernumber'},
1428                 issuedate       => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1429                 date_due        => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1430                 branchcode      => C4::Context->userenv->{'branch'},
1431                 onsite_checkout => $onsite_checkout,
1432                 auto_renew      => $auto_renew ? 1 : 0,
1433             };
1434
1435             $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1436             if ($issue) {
1437                 $issue->set($issue_attributes)->store;
1438             }
1439             else {
1440                 $issue = Koha::Checkout->new(
1441                     {
1442                         itemnumber => $item_object->itemnumber,
1443                         %$issue_attributes,
1444                     }
1445                 )->store;
1446             }
1447             if ( $item_object->location && $item_object->location eq 'CART'
1448                 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1449             ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1450                 CartToShelf( $item_object->itemnumber );
1451             }
1452
1453             if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1454                 UpdateTotalIssues( $item_object->biblionumber, 1 );
1455             }
1456
1457             ## If item was lost, it has now been found, reverse any list item charges if necessary.
1458             if ( $item_object->itemlost ) {
1459                 my $refund = 1;
1460                 my $no_refund_after_days = C4::Context->preference('NoRefundOnLostReturnedItemsAge');
1461                 if ($no_refund_after_days) {
1462                     my $today = dt_from_string();
1463                     my $lost_age_in_days =
1464                       dt_from_string( $item_object->itemlost_on )
1465                       ->delta_days($today)
1466                       ->in_units('days');
1467
1468                     $refund = 0 unless ( $lost_age_in_days < $no_refund_after_days );
1469                 }
1470
1471                 if (
1472                     $refund && Koha::CirculationRules->get_lostreturn_policy(
1473                         {
1474                             return_branch => C4::Context->userenv->{branch},
1475                             item          => $item_object
1476                         }
1477                     )
1478                   )
1479                 {
1480                     _FixAccountForLostAndFound( $item_object->itemnumber, undef,
1481                         $item_object->barcode );
1482                 }
1483             }
1484
1485             $item_object->issues( ( $item_object->issues || 0 ) + 1);
1486             $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1487             $item_object->itemlost(0);
1488             $item_object->onloan($datedue->ymd());
1489             $item_object->datelastborrowed( dt_from_string()->ymd() );
1490             $item_object->store({log_action => 0});
1491             ModDateLastSeen( $item_object->itemnumber );
1492
1493             # If it costs to borrow this book, charge it to the patron's account.
1494             my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1495             if ( $charge && $charge > 0 ) {
1496                 AddIssuingCharge( $issue, $charge, 'RENT' );
1497             }
1498
1499             my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1500             if ( $itemtype_object ) {
1501                 my $accumulate_charge = $fees->accumulate_rentalcharge();
1502                 if ( $accumulate_charge > 0 ) {
1503                     AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1504                     $charge += $accumulate_charge;
1505                     $item_unblessed->{charge} = $charge;
1506                 }
1507             }
1508
1509             # Record the fact that this book was issued.
1510             &UpdateStats(
1511                 {
1512                     branch => C4::Context->userenv->{'branch'},
1513                     type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1514                     amount         => $charge,
1515                     other          => ( $sipmode ? "SIP-$sipmode" : '' ),
1516                     itemnumber     => $item_object->itemnumber,
1517                     itemtype       => $item_object->effective_itemtype,
1518                     location       => $item_object->location,
1519                     borrowernumber => $borrower->{'borrowernumber'},
1520                     ccode          => $item_object->ccode,
1521                 }
1522             );
1523
1524             # Send a checkout slip.
1525             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1526             my %conditions        = (
1527                 branchcode   => $branchcode,
1528                 categorycode => $borrower->{categorycode},
1529                 item_type    => $item_object->effective_itemtype,
1530                 notification => 'CHECKOUT',
1531             );
1532             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1533                 SendCirculationAlert(
1534                     {
1535                         type     => 'CHECKOUT',
1536                         item     => $item_object->unblessed,
1537                         borrower => $borrower,
1538                         branch   => $branchcode,
1539                     }
1540                 );
1541             }
1542             logaction(
1543                 "CIRCULATION", "ISSUE",
1544                 $borrower->{'borrowernumber'},
1545                 $item_object->itemnumber,
1546             ) if C4::Context->preference("IssueLog");
1547
1548             Koha::Plugins->call('after_circ_action', {
1549                 action  => 'checkout',
1550                 payload => {
1551                     type     => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1552                     checkout => $issue->get_from_storage
1553                 }
1554             });
1555         }
1556     }
1557     return $issue;
1558 }
1559
1560 =head2 GetLoanLength
1561
1562   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1563
1564 Get loan length for an itemtype, a borrower type and a branch
1565
1566 =cut
1567
1568 sub GetLoanLength {
1569     my ( $categorycode, $itemtype, $branchcode ) = @_;
1570
1571     # Set search precedences
1572     my @params = (
1573         {
1574             categorycode => $categorycode,
1575             itemtype     => $itemtype,
1576             branchcode   => $branchcode,
1577         },
1578         {
1579             categorycode => $categorycode,
1580             itemtype     => undef,
1581             branchcode   => $branchcode,
1582         },
1583         {
1584             categorycode => undef,
1585             itemtype     => $itemtype,
1586             branchcode   => $branchcode,
1587         },
1588         {
1589             categorycode => undef,
1590             itemtype     => undef,
1591             branchcode   => $branchcode,
1592         },
1593         {
1594             categorycode => $categorycode,
1595             itemtype     => $itemtype,
1596             branchcode   => undef,
1597         },
1598         {
1599             categorycode => $categorycode,
1600             itemtype     => undef,
1601             branchcode   => undef,
1602         },
1603         {
1604             categorycode => undef,
1605             itemtype     => $itemtype,
1606             branchcode   => undef,
1607         },
1608         {
1609             categorycode => undef,
1610             itemtype     => undef,
1611             branchcode   => undef,
1612         },
1613     );
1614
1615     # Initialize default values
1616     my $rules = {
1617         issuelength   => 0,
1618         renewalperiod => 0,
1619         lengthunit    => 'days',
1620     };
1621
1622     # Search for rules!
1623     foreach my $rule_name (qw( issuelength renewalperiod lengthunit )) {
1624         foreach my $params (@params) {
1625             my $rule = Koha::CirculationRules->search(
1626                 {
1627                     rule_name => $rule_name,
1628                     %$params,
1629                 }
1630             )->next();
1631
1632             if ($rule) {
1633                 $rules->{$rule_name} = $rule->rule_value;
1634                 last;
1635             }
1636         }
1637     }
1638
1639     return $rules;
1640 }
1641
1642
1643 =head2 GetHardDueDate
1644
1645   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1646
1647 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1648
1649 =cut
1650
1651 sub GetHardDueDate {
1652     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1653
1654     my $rules = Koha::CirculationRules->get_effective_rules(
1655         {
1656             categorycode => $borrowertype,
1657             itemtype     => $itemtype,
1658             branchcode   => $branchcode,
1659             rules        => [ 'hardduedate', 'hardduedatecompare' ],
1660         }
1661     );
1662
1663     if ( defined( $rules->{hardduedate} ) ) {
1664         if ( $rules->{hardduedate} ) {
1665             return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1666         }
1667         else {
1668             return ( undef, undef );
1669         }
1670     }
1671 }
1672
1673 =head2 GetBranchBorrowerCircRule
1674
1675   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1676
1677 Retrieves circulation rule attributes that apply to the given
1678 branch and patron category, regardless of item type.
1679 The return value is a hashref containing the following key:
1680
1681 patron_maxissueqty - maximum number of loans that a
1682 patron of the given category can have at the given
1683 branch.  If the value is undef, no limit.
1684
1685 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1686 patron of the given category can have at the given
1687 branch.  If the value is undef, no limit.
1688
1689 This will check for different branch/category combinations in the following order:
1690 branch and category
1691 branch only
1692 category only
1693 default branch and category
1694
1695 If no rule has been found in the database, it will default to
1696 the buillt in rule:
1697
1698 patron_maxissueqty - undef
1699 patron_maxonsiteissueqty - undef
1700
1701 C<$branchcode> and C<$categorycode> should contain the
1702 literal branch code and patron category code, respectively - no
1703 wildcards.
1704
1705 =cut
1706
1707 sub GetBranchBorrowerCircRule {
1708     my ( $branchcode, $categorycode ) = @_;
1709
1710     # Initialize default values
1711     my $rules = {
1712         patron_maxissueqty       => undef,
1713         patron_maxonsiteissueqty => undef,
1714     };
1715
1716     # Search for rules!
1717     foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1718         my $rule = Koha::CirculationRules->get_effective_rule(
1719             {
1720                 categorycode => $categorycode,
1721                 itemtype     => undef,
1722                 branchcode   => $branchcode,
1723                 rule_name    => $rule_name,
1724             }
1725         );
1726
1727         $rules->{$rule_name} = $rule->rule_value if defined $rule;
1728     }
1729
1730     return $rules;
1731 }
1732
1733 =head2 GetBranchItemRule
1734
1735   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1736
1737 Retrieves circulation rule attributes that apply to the given
1738 branch and item type, regardless of patron category.
1739
1740 The return value is a hashref containing the following keys:
1741
1742 holdallowed => Hold policy for this branch and itemtype. Possible values:
1743   0: No holds allowed.
1744   1: Holds allowed only by patrons that have the same homebranch as the item.
1745   2: Holds allowed from any patron.
1746
1747 returnbranch => branch to which to return item.  Possible values:
1748   noreturn: do not return, let item remain where checked in (floating collections)
1749   homebranch: return to item's home branch
1750   holdingbranch: return to issuer branch
1751
1752 This searches branchitemrules in the following order:
1753
1754   * Same branchcode and itemtype
1755   * Same branchcode, itemtype '*'
1756   * branchcode '*', same itemtype
1757   * branchcode and itemtype '*'
1758
1759 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1760
1761 =cut
1762
1763 sub GetBranchItemRule {
1764     my ( $branchcode, $itemtype ) = @_;
1765
1766     # Search for rules!
1767     my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1768         {
1769             branchcode => $branchcode,
1770             itemtype => $itemtype,
1771             rule_name => 'holdallowed',
1772         }
1773     );
1774     my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1775         {
1776             branchcode => $branchcode,
1777             itemtype => $itemtype,
1778             rule_name => 'hold_fulfillment_policy',
1779         }
1780     );
1781     my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1782         {
1783             branchcode => $branchcode,
1784             itemtype => $itemtype,
1785             rule_name => 'returnbranch',
1786         }
1787     );
1788
1789     # built-in default circulation rule
1790     my $rules;
1791     $rules->{holdallowed} = defined $holdallowed_rule
1792         ? $holdallowed_rule->rule_value
1793         : 2;
1794     $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1795         ? $hold_fulfillment_policy_rule->rule_value
1796         : 'any';
1797     $rules->{returnbranch} = defined $returnbranch_rule
1798         ? $returnbranch_rule->rule_value
1799         : 'homebranch';
1800
1801     return $rules;
1802 }
1803
1804 =head2 AddReturn
1805
1806   ($doreturn, $messages, $iteminformation, $borrower) =
1807       &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1808
1809 Returns a book.
1810
1811 =over 4
1812
1813 =item C<$barcode> is the bar code of the book being returned.
1814
1815 =item C<$branch> is the code of the branch where the book is being returned.
1816
1817 =item C<$exemptfine> indicates that overdue charges for the item will be
1818 removed. Optional.
1819
1820 =item C<$return_date> allows the default return date to be overridden
1821 by the given return date. Optional.
1822
1823 =back
1824
1825 C<&AddReturn> returns a list of four items:
1826
1827 C<$doreturn> is true iff the return succeeded.
1828
1829 C<$messages> is a reference-to-hash giving feedback on the operation.
1830 The keys of the hash are:
1831
1832 =over 4
1833
1834 =item C<BadBarcode>
1835
1836 No item with this barcode exists. The value is C<$barcode>.
1837
1838 =item C<NotIssued>
1839
1840 The book is not currently on loan. The value is C<$barcode>.
1841
1842 =item C<withdrawn>
1843
1844 This book has been withdrawn/cancelled. The value should be ignored.
1845
1846 =item C<Wrongbranch>
1847
1848 This book has was returned to the wrong branch.  The value is a hashref
1849 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1850 contain the branchcode of the incorrect and correct return library, respectively.
1851
1852 =item C<ResFound>
1853
1854 The item was reserved. The value is a reference-to-hash whose keys are
1855 fields from the reserves table of the Koha database, and
1856 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1857 either C<Waiting>, C<Reserved>, or 0.
1858
1859 =item C<WasReturned>
1860
1861 Value 1 if return is successful.
1862
1863 =item C<NeedsTransfer>
1864
1865 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1866
1867 =back
1868
1869 C<$iteminformation> is a reference-to-hash, giving information about the
1870 returned item from the issues table.
1871
1872 C<$borrower> is a reference-to-hash, giving information about the
1873 patron who last borrowed the book.
1874
1875 =cut
1876
1877 sub AddReturn {
1878     my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1879
1880     if ($branch and not Koha::Libraries->find($branch)) {
1881         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1882         undef $branch;
1883     }
1884     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1885     my $return_date_specified = !!$return_date;
1886     $return_date //= dt_from_string();
1887     my $messages;
1888     my $patron;
1889     my $doreturn       = 1;
1890     my $validTransfert = 0;
1891     my $stat_type = 'return';
1892
1893     # get information on item
1894     my $item = Koha::Items->find({ barcode => $barcode });
1895     unless ($item) {
1896         return ( 0, { BadBarcode => $barcode } );    # no barcode means no item or borrower.  bail out.
1897     }
1898
1899     my $itemnumber = $item->itemnumber;
1900     my $itemtype = $item->effective_itemtype;
1901
1902     my $issue  = $item->checkout;
1903     if ( $issue ) {
1904         $patron = $issue->patron
1905             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1906                 . Dumper($issue->unblessed) . "\n";
1907     } else {
1908         $messages->{'NotIssued'} = $barcode;
1909         $item->onloan(undef)->store if defined $item->onloan;
1910
1911         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1912         $doreturn = 0;
1913         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1914         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1915         if (C4::Context->preference("RecordLocalUseOnReturn")) {
1916            $messages->{'LocalUse'} = 1;
1917            $stat_type = 'localuse';
1918         }
1919     }
1920
1921         # full item data, but no borrowernumber or checkout info (no issue)
1922     my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1923         # get the proper branch to which to return the item
1924     my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1925         # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1926     my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
1927
1928     my $borrowernumber = $patron ? $patron->borrowernumber : undef;    # we don't know if we had a borrower or not
1929     my $patron_unblessed = $patron ? $patron->unblessed : {};
1930
1931     my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1932     map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1933     if ($update_loc_rules) {
1934         if (defined $update_loc_rules->{_ALL_}) {
1935             if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1936             if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1937             if ( $item->location ne $update_loc_rules->{_ALL_}) {
1938                 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1939                 $item->location($update_loc_rules->{_ALL_})->store;
1940             }
1941         }
1942         else {
1943             foreach my $key ( keys %$update_loc_rules ) {
1944                 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1945                 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1946                 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1947                     $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
1948                     $item->location($update_loc_rules->{$key})->store;
1949                     last;
1950                 }
1951             }
1952         }
1953     }
1954
1955     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1956     if ($yaml) {
1957         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
1958         my $rules;
1959         eval { $rules = YAML::Load($yaml); };
1960         if ($@) {
1961             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1962         }
1963         else {
1964             foreach my $key ( keys %$rules ) {
1965                 if ( $item->notforloan eq $key ) {
1966                     $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1967                     $item->notforloan($rules->{$key})->store({ log_action => 0 });
1968                     last;
1969                 }
1970             }
1971         }
1972     }
1973
1974     # check if the return is allowed at this branch
1975     my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
1976     unless ($returnallowed){
1977         $messages->{'Wrongbranch'} = {
1978             Wrongbranch => $branch,
1979             Rightbranch => $message
1980         };
1981         $doreturn = 0;
1982         return ( $doreturn, $messages, $issue, $patron_unblessed);
1983     }
1984
1985     if ( $item->withdrawn ) { # book has been cancelled
1986         $messages->{'withdrawn'} = 1;
1987         $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1988     }
1989
1990     if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1991         $doreturn = 0;
1992     }
1993
1994     # case of a return of document (deal with issues and holdingbranch)
1995     if ($doreturn) {
1996         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1997         $patron or warn "AddReturn without current borrower";
1998
1999         if ($patron) {
2000             eval {
2001                 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
2002             };
2003             unless ( $@ ) {
2004                 if (
2005                     (
2006                         C4::Context->preference('CalculateFinesOnReturn')
2007                         || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2008                     )
2009                     && !$item->itemlost
2010                   )
2011                 {
2012                     _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2013                 }
2014             } else {
2015                 carp "The checkin for the following issue failed, Please go to the about page, section 'data corrupted' to know how to fix this problem ($@)" . Dumper( $issue->unblessed );
2016
2017                 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2018             }
2019
2020             # FIXME is the "= 1" right?  This could be the borrower hash.
2021             $messages->{'WasReturned'} = 1;
2022
2023         }
2024
2025         $item->onloan(undef)->store({ log_action => 0 });
2026     }
2027
2028     # the holdingbranch is updated if the document is returned to another location.
2029     # this is always done regardless of whether the item was on loan or not
2030     my $item_holding_branch = $item->holdingbranch;
2031     if ($item->holdingbranch ne $branch) {
2032         $item->holdingbranch($branch)->store;
2033     }
2034
2035     my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2036     ModDateLastSeen( $item->itemnumber, $leave_item_lost );
2037
2038     # check if we have a transfer for this document
2039     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
2040
2041     # if we have a transfer to do, we update the line of transfers with the datearrived
2042     my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
2043     if ($datesent) {
2044         if ( $tobranch eq $branch ) {
2045             my $sth = C4::Context->dbh->prepare(
2046                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2047             );
2048             $sth->execute( $item->itemnumber );
2049         } else {
2050             $messages->{'WrongTransfer'}     = $tobranch;
2051             $messages->{'WrongTransferItem'} = $item->itemnumber;
2052         }
2053         $validTransfert = 1;
2054     }
2055
2056     # fix up the accounts.....
2057     if ( $item->itemlost ) {
2058         $messages->{'WasLost'} = 1;
2059         unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2060             my $refund = 1;
2061             my $no_refund_after_days = C4::Context->preference('NoRefundOnLostReturnedItemsAge');
2062             if ($no_refund_after_days) {
2063                 my $today = dt_from_string();
2064                 my $lost_age_in_days =
2065                   dt_from_string( $item->itemlost_on )
2066                   ->delta_days($today)
2067                   ->in_units('days');
2068
2069                 $refund = 0 unless ( $lost_age_in_days < $no_refund_after_days );
2070             }
2071
2072             if (
2073                 $refund &&
2074                 Koha::CirculationRules->get_lostreturn_policy(
2075                     {
2076                         return_branch => C4::Context->userenv->{branch},
2077                         item          => $item,
2078                     }
2079                   )
2080               )
2081             {
2082                 _FixAccountForLostAndFound( $item->itemnumber,
2083                     $borrowernumber, $barcode );
2084                 $messages->{'LostItemFeeRefunded'} = 1;
2085             }
2086         }
2087     }
2088
2089     # fix up the overdues in accounts...
2090     if ($borrowernumber) {
2091         my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2092         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!";  # zero is OK, check defined
2093
2094         if ( $issue and $issue->is_overdue($return_date) ) {
2095         # fix fine days
2096             my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2097             if ($reminder){
2098                 $messages->{'PrevDebarred'} = $debardate;
2099             } else {
2100                 $messages->{'Debarred'} = $debardate if $debardate;
2101             }
2102         # there's no overdue on the item but borrower had been previously debarred
2103         } elsif ( $issue->date_due and $patron->debarred ) {
2104              if ( $patron->debarred eq "9999-12-31") {
2105                 $messages->{'ForeverDebarred'} = $patron->debarred;
2106              } else {
2107                   my $borrower_debar_dt = dt_from_string( $patron->debarred );
2108                   $borrower_debar_dt->truncate(to => 'day');
2109                   my $today_dt = $return_date->clone()->truncate(to => 'day');
2110                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2111                       $messages->{'PrevDebarred'} = $patron->debarred;
2112                   }
2113              }
2114         }
2115     }
2116
2117     # find reserves.....
2118     # launch the Checkreserves routine to find any holds
2119     my ($resfound, $resrec);
2120     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2121     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2122     # if a hold is found and is waiting at another branch, change the priority back to 1 and trigger the hold (this will trigger a transfer and update the hold status properly)
2123     if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2124         my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2125         $resfound = 'Reserved';
2126         $resrec = $hold->unblessed;
2127     }
2128     if ($resfound) {
2129           $resrec->{'ResFound'} = $resfound;
2130         $messages->{'ResFound'} = $resrec;
2131     }
2132
2133     # Record the fact that this book was returned.
2134     UpdateStats({
2135         branch         => $branch,
2136         type           => $stat_type,
2137         itemnumber     => $itemnumber,
2138         itemtype       => $itemtype,
2139         location       => $item->location,
2140         borrowernumber => $borrowernumber,
2141         ccode          => $item->ccode,
2142     });
2143
2144     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2145     if ( $patron ) {
2146         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2147         my %conditions = (
2148             branchcode   => $branch,
2149             categorycode => $patron->categorycode,
2150             item_type    => $itemtype,
2151             notification => 'CHECKIN',
2152         );
2153         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2154             SendCirculationAlert({
2155                 type     => 'CHECKIN',
2156                 item     => $item->unblessed,
2157                 borrower => $patron->unblessed,
2158                 branch   => $branch,
2159             });
2160         }
2161
2162         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2163             if C4::Context->preference("ReturnLog");
2164         }
2165
2166     # Check if this item belongs to a biblio record that is attached to an
2167     # ILL request, if it is we need to update the ILL request's status
2168     if (C4::Context->preference('CirculateILL')) {
2169         my $request = Koha::Illrequests->find(
2170             { biblio_id => $item->biblio->biblionumber }
2171         );
2172         $request->status('RET') if $request;
2173     }
2174
2175     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2176     if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2177         my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2178         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2179             (C4::Context->preference("UseBranchTransferLimits") and
2180              ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2181            )) {
2182             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s, %s)", $item->itemnumber,$branch, $returnbranch, $transfer_trigger;
2183             $debug and warn "item: " . Dumper($item->unblessed);
2184             ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger);
2185             $messages->{'WasTransfered'} = 1;
2186         } else {
2187             $messages->{'NeedsTransfer'} = $returnbranch;
2188             $messages->{'TransferTrigger'} = $transfer_trigger;
2189         }
2190     }
2191
2192     if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2193         my $claims = Koha::Checkouts::ReturnClaims->search(
2194            {
2195                itemnumber => $item->id,
2196                resolution => undef,
2197            }
2198         );
2199
2200         if ( $claims->count ) {
2201             $messages->{ReturnClaims} = $claims;
2202         }
2203     }
2204
2205     if ( $doreturn and $issue ) {
2206         my $checkin = Koha::Old::Checkouts->find($issue->id);
2207
2208         Koha::Plugins->call('after_circ_action', {
2209             action  => 'checkin',
2210             payload => {
2211                 checkout=> $checkin
2212             }
2213         });
2214     }
2215
2216     return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2217 }
2218
2219 =head2 MarkIssueReturned
2220
2221   MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2222
2223 Unconditionally marks an issue as being returned by
2224 moving the C<issues> row to C<old_issues> and
2225 setting C<returndate> to the current date.
2226
2227 if C<$returndate> is specified (in iso format), it is used as the date
2228 of the return.
2229
2230 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2231 the old_issue is immediately anonymised
2232
2233 Ideally, this function would be internal to C<C4::Circulation>,
2234 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2235 and offline_circ/process_koc.pl.
2236
2237 =cut
2238
2239 sub MarkIssueReturned {
2240     my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2241
2242     # Retrieve the issue
2243     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2244
2245     return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2246
2247     my $issue_id = $issue->issue_id;
2248
2249     my $anonymouspatron;
2250     if ( $privacy && $privacy == 2 ) {
2251         # The default of 0 will not work due to foreign key constraints
2252         # The anonymisation will fail if AnonymousPatron is not a valid entry
2253         # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2254         # Note that a warning should appear on the about page (System information tab).
2255         $anonymouspatron = C4::Context->preference('AnonymousPatron');
2256         die "Fatal error: the patron ($borrowernumber) has requested their circulation history be anonymized on check-in, but the AnonymousPatron system preference is empty or not set correctly."
2257             unless Koha::Patrons->find( $anonymouspatron );
2258     }
2259
2260     my $schema = Koha::Database->schema;
2261
2262     # FIXME Improve the return value and handle it from callers
2263     $schema->txn_do(sub {
2264
2265         my $patron = Koha::Patrons->find( $borrowernumber );
2266
2267         # Update the returndate value
2268         if ( $returndate ) {
2269             $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2270         }
2271         else {
2272             $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2273         }
2274
2275         # Create the old_issues entry
2276         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2277
2278         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2279         if ( $privacy && $privacy == 2) {
2280             $old_checkout->borrowernumber($anonymouspatron)->store;
2281         }
2282
2283         # And finally delete the issue
2284         $issue->delete;
2285
2286         $issue->item->onloan(undef)->store({ log_action => 0 });
2287
2288         if ( C4::Context->preference('StoreLastBorrower') ) {
2289             my $item = Koha::Items->find( $itemnumber );
2290             $item->last_returned_by( $patron );
2291         }
2292
2293         # Remove any OVERDUES related debarment if the borrower has no overdues
2294         if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2295           && $patron->debarred
2296           && !$patron->has_overdues
2297           && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2298         ) {
2299             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2300         }
2301
2302     });
2303
2304     return $issue_id;
2305 }
2306
2307 =head2 _debar_user_on_return
2308
2309     _debar_user_on_return($borrower, $item, $datedue, $returndate);
2310
2311 C<$borrower> borrower hashref
2312
2313 C<$item> item hashref
2314
2315 C<$datedue> date due DateTime object
2316
2317 C<$returndate> DateTime object representing the return time
2318
2319 Internal function, called only by AddReturn that calculates and updates
2320  the user fine days, and debars them if necessary.
2321
2322 Should only be called for overdue returns
2323
2324 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2325 to ease testing.
2326
2327 =cut
2328
2329 sub _calculate_new_debar_dt {
2330     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2331
2332     my $branchcode = _GetCircControlBranch( $item, $borrower );
2333     my $circcontrol = C4::Context->preference('CircControl');
2334     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2335         {   categorycode => $borrower->{categorycode},
2336             itemtype     => $item->{itype},
2337             branchcode   => $branchcode,
2338             rules => [
2339                 'finedays',
2340                 'lengthunit',
2341                 'firstremind',
2342                 'maxsuspensiondays',
2343                 'suspension_chargeperiod',
2344             ]
2345         }
2346     );
2347     my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2348     my $unit     = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2349     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2350
2351     return unless $finedays;
2352
2353     # finedays is in days, so hourly loans must multiply by 24
2354     # thus 1 hour late equals 1 day suspension * finedays rate
2355     $finedays = $finedays * 24 if ( $unit eq 'hours' );
2356
2357     # grace period is measured in the same units as the loan
2358     my $grace =
2359       DateTime::Duration->new( $unit => $issuing_rule->{firstremind} );
2360
2361     my $deltadays = DateTime::Duration->new(
2362         days => $chargeable_units
2363     );
2364
2365     if ( $deltadays->subtract($grace)->is_positive() ) {
2366         my $suspension_days = $deltadays * $finedays;
2367
2368         if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2369             # No need to / 1 and do not consider / 0
2370             $suspension_days = DateTime::Duration->new(
2371                 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2372             );
2373         }
2374
2375         # If the max suspension days is < than the suspension days
2376         # the suspension days is limited to this maximum period.
2377         my $max_sd = $issuing_rule->{maxsuspensiondays};
2378         if ( defined $max_sd && $max_sd ne '' ) {
2379             $max_sd = DateTime::Duration->new( days => $max_sd );
2380             $suspension_days = $max_sd
2381               if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2382         }
2383
2384         my ( $has_been_extended );
2385         if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2386             my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2387             if ( $debarment ) {
2388                 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2389                 $has_been_extended = 1;
2390             }
2391         }
2392
2393         my $new_debar_dt;
2394         # Use the calendar or not to calculate the debarment date
2395         if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2396             my $calendar = Koha::Calendar->new(
2397                 branchcode => $branchcode,
2398                 days_mode  => 'Calendar'
2399             );
2400             $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2401         }
2402         else {
2403             $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2404         }
2405         return $new_debar_dt;
2406     }
2407     return;
2408 }
2409
2410 sub _debar_user_on_return {
2411     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2412
2413     $return_date //= dt_from_string();
2414
2415     my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2416
2417     return unless $new_debar_dt;
2418
2419     Koha::Patron::Debarments::AddUniqueDebarment({
2420         borrowernumber => $borrower->{borrowernumber},
2421         expiration     => $new_debar_dt->ymd(),
2422         type           => 'SUSPENSION',
2423     });
2424     # if borrower was already debarred but does not get an extra debarment
2425     my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2426     my ($new_debarment_str, $is_a_reminder);
2427     if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2428         $is_a_reminder = 1;
2429         $new_debarment_str = $borrower->{debarred};
2430     } else {
2431         $new_debarment_str = $new_debar_dt->ymd();
2432     }
2433     # FIXME Should return a DateTime object
2434     return $new_debarment_str, $is_a_reminder;
2435 }
2436
2437 =head2 _FixOverduesOnReturn
2438
2439    &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2440
2441 C<$borrowernumber> borrowernumber
2442
2443 C<$itemnumber> itemnumber
2444
2445 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2446
2447 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2448
2449 Internal function
2450
2451 =cut
2452
2453 sub _FixOverduesOnReturn {
2454     my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2455     unless( $borrowernumber ) {
2456         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2457         return;
2458     }
2459     unless( $item ) {
2460         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2461         return;
2462     }
2463     unless( $status ) {
2464         warn "_FixOverduesOnReturn() not supplied valid status";
2465         return;
2466     }
2467
2468     my $schema = Koha::Database->schema;
2469
2470     my $result = $schema->txn_do(
2471         sub {
2472             # check for overdue fine
2473             my $accountlines = Koha::Account::Lines->search(
2474                 {
2475                     borrowernumber  => $borrowernumber,
2476                     itemnumber      => $item,
2477                     debit_type_code => 'OVERDUE',
2478                     status          => 'UNRETURNED'
2479                 }
2480             );
2481             return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2482
2483             my $accountline = $accountlines->next;
2484             my $payments = $accountline->credits;
2485
2486             my $amountoutstanding = $accountline->amountoutstanding;
2487             if ( $accountline->amount == 0 && $payments->count == 0 ) {
2488                 $accountline->delete;
2489             } elsif ($exemptfine && ($amountoutstanding != 0)) {
2490                 my $account = Koha::Account->new({patron_id => $borrowernumber});
2491                 my $credit = $account->add_credit(
2492                     {
2493                         amount     => $amountoutstanding,
2494                         user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2495                         library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2496                         interface  => C4::Context->interface,
2497                         type       => 'FORGIVEN',
2498                         item_id    => $item
2499                     }
2500                 );
2501
2502                 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2503
2504                 if (C4::Context->preference("FinesLog")) {
2505                     &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2506                 }
2507
2508                 $accountline->status('FORGIVEN');
2509                 $accountline->store();
2510             } else {
2511                 $accountline->status($status);
2512                 $accountline->store();
2513
2514             }
2515         }
2516     );
2517
2518     return $result;
2519 }
2520
2521 =head2 _FixAccountForLostAndFound
2522
2523   &_FixAccountForLostAndFound($itemnumber, [$borrowernumber, $barcode]);
2524
2525 Finds the most recent lost item charge for this item and refunds the borrower
2526 appropriatly, taking into account any payments or writeoffs already applied
2527 against the charge.
2528
2529 Internal function, not exported, called only by AddReturn.
2530
2531 =cut
2532
2533 sub _FixAccountForLostAndFound {
2534     my $itemnumber     = shift or return;
2535     my $borrowernumber = @_ ? shift : undef;
2536     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
2537
2538     my $credit;
2539
2540     # check for charge made for lost book
2541     my $accountlines = Koha::Account::Lines->search(
2542         {
2543             itemnumber      => $itemnumber,
2544             debit_type_code => 'LOST',
2545             status          => [ undef, { '<>' => 'FOUND' } ]
2546         },
2547         {
2548             order_by => { -desc => [ 'date', 'accountlines_id' ] }
2549         }
2550     );
2551
2552     return unless $accountlines->count > 0;
2553     my $accountline     = $accountlines->next;
2554     my $total_to_refund = 0;
2555
2556     return unless $accountline->borrowernumber;
2557     my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2558     return unless $patron; # Patron has been deleted, nobody to credit the return to
2559
2560     my $account = $patron->account;
2561
2562     # Use cases
2563     if ( $accountline->amount > $accountline->amountoutstanding ) {
2564         # some amount has been cancelled. collect the offsets that are not writeoffs
2565         # this works because the only way to subtract from this kind of a debt is
2566         # using the UI buttons 'Pay' and 'Write off'
2567         my $credits_offsets = Koha::Account::Offsets->search({
2568             debit_id  => $accountline->id,
2569             credit_id => { '!=' => undef }, # it is not the debit itself
2570             type      => { '!=' => 'Writeoff' },
2571             amount    => { '<'  => 0 } # credits are negative on the DB
2572         });
2573
2574         $total_to_refund = ( $credits_offsets->count > 0 )
2575                             ? $credits_offsets->total * -1 # credits are negative on the DB
2576                             : 0;
2577     }
2578
2579     my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2580
2581     if ( $credit_total > 0 ) {
2582         my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2583         $credit = $account->add_credit(
2584             {
2585                 amount      => $credit_total,
2586                 description => 'Item found ' . $item_id,
2587                 type        => 'LOST_FOUND',
2588                 interface   => C4::Context->interface,
2589                 library_id  => $branchcode,
2590                 item_id     => $itemnumber
2591             }
2592         );
2593
2594         $credit->apply( { debits => [ $accountline ] } );
2595     }
2596
2597     # Update the account status
2598     $accountline->discard_changes->status('FOUND');
2599     $accountline->store;
2600
2601     $accountline->item->paidfor('')->store({ log_action => 0 });
2602
2603     if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2604         $account->reconcile_balance;
2605     }
2606
2607     return ($credit) ? $credit->id : undef;
2608 }
2609
2610 =head2 _GetCircControlBranch
2611
2612    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2613
2614 Internal function :
2615
2616 Return the library code to be used to determine which circulation
2617 policy applies to a transaction.  Looks up the CircControl and
2618 HomeOrHoldingBranch system preferences.
2619
2620 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2621
2622 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2623
2624 =cut
2625
2626 sub _GetCircControlBranch {
2627     my ($item, $borrower) = @_;
2628     my $circcontrol = C4::Context->preference('CircControl');
2629     my $branch;
2630
2631     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2632         $branch= C4::Context->userenv->{'branch'};
2633     } elsif ($circcontrol eq 'PatronLibrary') {
2634         $branch=$borrower->{branchcode};
2635     } else {
2636         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2637         $branch = $item->{$branchfield};
2638         # default to item home branch if holdingbranch is used
2639         # and is not defined
2640         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2641             $branch = $item->{homebranch};
2642         }
2643     }
2644     return $branch;
2645 }
2646
2647 =head2 GetOpenIssue
2648
2649   $issue = GetOpenIssue( $itemnumber );
2650
2651 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2652
2653 C<$itemnumber> is the item's itemnumber
2654
2655 Returns a hashref
2656
2657 =cut
2658
2659 sub GetOpenIssue {
2660   my ( $itemnumber ) = @_;
2661   return unless $itemnumber;
2662   my $dbh = C4::Context->dbh;
2663   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2664   $sth->execute( $itemnumber );
2665   return $sth->fetchrow_hashref();
2666
2667 }
2668
2669 =head2 GetBiblioIssues
2670
2671   $issues = GetBiblioIssues($biblionumber);
2672
2673 this function get all issues from a biblionumber.
2674
2675 Return:
2676 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2677 tables issues and the firstname,surname & cardnumber from borrowers.
2678
2679 =cut
2680
2681 sub GetBiblioIssues {
2682     my $biblionumber = shift;
2683     return unless $biblionumber;
2684     my $dbh   = C4::Context->dbh;
2685     my $query = "
2686         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2687         FROM issues
2688             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2689             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2690             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2691             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2692         WHERE biblio.biblionumber = ?
2693         UNION ALL
2694         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2695         FROM old_issues
2696             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2697             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2698             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2699             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2700         WHERE biblio.biblionumber = ?
2701         ORDER BY timestamp
2702     ";
2703     my $sth = $dbh->prepare($query);
2704     $sth->execute($biblionumber, $biblionumber);
2705
2706     my @issues;
2707     while ( my $data = $sth->fetchrow_hashref ) {
2708         push @issues, $data;
2709     }
2710     return \@issues;
2711 }
2712
2713 =head2 GetUpcomingDueIssues
2714
2715   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2716
2717 =cut
2718
2719 sub GetUpcomingDueIssues {
2720     my $params = shift;
2721
2722     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2723     my $dbh = C4::Context->dbh;
2724
2725     my $statement = <<END_SQL;
2726 SELECT *
2727 FROM (
2728     SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2729     FROM issues
2730     LEFT JOIN items USING (itemnumber)
2731     LEFT OUTER JOIN branches USING (branchcode)
2732     WHERE returndate is NULL
2733 ) tmp
2734 WHERE days_until_due >= 0 AND days_until_due <= ?
2735 END_SQL
2736
2737     my @bind_parameters = ( $params->{'days_in_advance'} );
2738
2739     my $sth = $dbh->prepare( $statement );
2740     $sth->execute( @bind_parameters );
2741     my $upcoming_dues = $sth->fetchall_arrayref({});
2742
2743     return $upcoming_dues;
2744 }
2745
2746 =head2 CanBookBeRenewed
2747
2748   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2749
2750 Find out whether a borrowed item may be renewed.
2751
2752 C<$borrowernumber> is the borrower number of the patron who currently
2753 has the item on loan.
2754
2755 C<$itemnumber> is the number of the item to renew.
2756
2757 C<$override_limit>, if supplied with a true value, causes
2758 the limit on the number of times that the loan can be renewed
2759 (as controlled by the item type) to be ignored. Overriding also allows
2760 to renew sooner than "No renewal before" and to manually renew loans
2761 that are automatically renewed.
2762
2763 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2764 item must currently be on loan to the specified borrower; renewals
2765 must be allowed for the item's type; and the borrower must not have
2766 already renewed the loan. $error will contain the reason the renewal can not proceed
2767
2768 =cut
2769
2770 sub CanBookBeRenewed {
2771     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2772
2773     my $dbh    = C4::Context->dbh;
2774     my $renews = 1;
2775     my $auto_renew = 0;
2776
2777     my $item      = Koha::Items->find($itemnumber)      or return ( 0, 'no_item' );
2778     my $issue = $item->checkout or return ( 0, 'no_checkout' );
2779     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2780     return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2781
2782     my $patron = $issue->patron or return;
2783
2784     # override_limit will override anything else except on_reserve
2785     unless ( $override_limit ){
2786         my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2787         my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2788             {
2789                 categorycode => $patron->categorycode,
2790                 itemtype     => $item->effective_itemtype,
2791                 branchcode   => $branchcode,
2792                 rules => [
2793                     'renewalsallowed',
2794                     'no_auto_renewal_after',
2795                     'no_auto_renewal_after_hard_limit',
2796                     'lengthunit',
2797                     'norenewalbefore',
2798                 ]
2799             }
2800         );
2801
2802         return ( 0, "too_many" )
2803           if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2804
2805         my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2806         my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2807         $patron         = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2808         my $restricted  = $patron->is_debarred;
2809         my $hasoverdues = $patron->has_overdues;
2810
2811         if ( $restricted and $restrictionblockrenewing ) {
2812             return ( 0, 'restriction');
2813         } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2814             return ( 0, 'overdue');
2815         }
2816
2817         if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2818
2819             if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2820                 return ( 0, 'auto_account_expired' );
2821             }
2822
2823             if ( defined $issuing_rule->{no_auto_renewal_after}
2824                     and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2825                 # Get issue_date and add no_auto_renewal_after
2826                 # If this is greater than today, it's too late for renewal.
2827                 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2828                 $maximum_renewal_date->add(
2829                     $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2830                 );
2831                 my $now = dt_from_string;
2832                 if ( $now >= $maximum_renewal_date ) {
2833                     return ( 0, "auto_too_late" );
2834                 }
2835             }
2836             if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2837                           and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2838                 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2839                 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2840                     return ( 0, "auto_too_late" );
2841                 }
2842             }
2843
2844             if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2845                 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2846                 my $amountoutstanding =
2847                   C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2848                   ? $patron->account->balance
2849                   : $patron->account->outstanding_debits->total_outstanding;
2850                 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2851                     return ( 0, "auto_too_much_oweing" );
2852                 }
2853             }
2854         }
2855
2856         if ( defined $issuing_rule->{norenewalbefore}
2857             and $issuing_rule->{norenewalbefore} ne "" )
2858         {
2859
2860             # Calculate soonest renewal by subtracting 'No renewal before' from due date
2861             my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2862                 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2863
2864             # Depending on syspref reset the exact time, only check the date
2865             if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2866                 and $issuing_rule->{lengthunit} eq 'days' )
2867             {
2868                 $soonestrenewal->truncate( to => 'day' );
2869             }
2870
2871             if ( $soonestrenewal > dt_from_string() )
2872             {
2873                 return ( 0, "auto_too_soon" ) if $issue->auto_renew && $patron->autorenew_checkouts;
2874                 return ( 0, "too_soon" );
2875             }
2876             elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2877                 $auto_renew = 1;
2878             }
2879         }
2880
2881         # Fallback for automatic renewals:
2882         # If norenewalbefore is undef, don't renew before due date.
2883         if ( $issue->auto_renew && !$auto_renew && $patron->autorenew_checkouts ) {
2884             my $now = dt_from_string;
2885             if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2886                 $auto_renew = 1;
2887             } else {
2888                 return ( 0, "auto_too_soon" );
2889             }
2890         }
2891     }
2892
2893     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2894
2895     # This item can fill one or more unfilled reserve, can those unfilled reserves
2896     # all be filled by other available items?
2897     if ( $resfound
2898         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2899     {
2900         my $schema = Koha::Database->new()->schema();
2901
2902         my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2903         if ($item_holds) {
2904             # There is an item level hold on this item, no other item can fill the hold
2905             $resfound = 1;
2906         }
2907         else {
2908
2909             # Get all other items that could possibly fill reserves
2910             my @itemnumbers = $schema->resultset('Item')->search(
2911                 {
2912                     biblionumber => $resrec->{biblionumber},
2913                     onloan       => undef,
2914                     notforloan   => 0,
2915                     -not         => { itemnumber => $itemnumber }
2916                 },
2917                 { columns => 'itemnumber' }
2918             )->get_column('itemnumber')->all();
2919
2920             # Get all other reserves that could have been filled by this item
2921             my @borrowernumbers;
2922             while (1) {
2923                 my ( $reserve_found, $reserve, undef ) =
2924                   C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2925
2926                 if ($reserve_found) {
2927                     push( @borrowernumbers, $reserve->{borrowernumber} );
2928                 }
2929                 else {
2930                     last;
2931                 }
2932             }
2933
2934             # If the count of the union of the lists of reservable items for each borrower
2935             # is equal or greater than the number of borrowers, we know that all reserves
2936             # can be filled with available items. We can get the union of the sets simply
2937             # by pushing all the elements onto an array and removing the duplicates.
2938             my @reservable;
2939             my %patrons;
2940             ITEM: foreach my $itemnumber (@itemnumbers) {
2941                 my $item = Koha::Items->find( $itemnumber );
2942                 next if IsItemOnHoldAndFound( $itemnumber );
2943                 for my $borrowernumber (@borrowernumbers) {
2944                     my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2945                     next unless IsAvailableForItemLevelRequest($item, $patron);
2946                     next unless CanItemBeReserved($borrowernumber,$itemnumber);
2947
2948                     push @reservable, $itemnumber;
2949                     if (@reservable >= @borrowernumbers) {
2950                         $resfound = 0;
2951                         last ITEM;
2952                     }
2953                     last;
2954                 }
2955             }
2956         }
2957     }
2958     return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2959     return ( 0, "auto_renew" ) if $auto_renew && !$override_limit; # 0 if auto-renewal should not succeed
2960
2961     return ( 1, undef );
2962 }
2963
2964 =head2 AddRenewal
2965
2966   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2967
2968 Renews a loan.
2969
2970 C<$borrowernumber> is the borrower number of the patron who currently
2971 has the item.
2972
2973 C<$itemnumber> is the number of the item to renew.
2974
2975 C<$branch> is the library where the renewal took place (if any).
2976            The library that controls the circ policies for the renewal is retrieved from the issues record.
2977
2978 C<$datedue> can be a DateTime object used to set the due date.
2979
2980 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2981 this parameter is not supplied, lastreneweddate is set to the current date.
2982
2983 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2984 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2985 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2986 syspref)
2987
2988 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2989 from the book's item type.
2990
2991 =cut
2992
2993 sub AddRenewal {
2994     my $borrowernumber  = shift;
2995     my $itemnumber      = shift or return;
2996     my $branch          = shift;
2997     my $datedue         = shift;
2998     my $lastreneweddate = shift || dt_from_string();
2999     my $skipfinecalc    = shift;
3000
3001     my $item_object   = Koha::Items->find($itemnumber) or return;
3002     my $biblio = $item_object->biblio;
3003     my $issue  = $item_object->checkout;
3004     my $item_unblessed = $item_object->unblessed;
3005
3006     my $dbh = C4::Context->dbh;
3007
3008     return unless $issue;
3009
3010     $borrowernumber ||= $issue->borrowernumber;
3011
3012     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3013         carp 'Invalid date passed to AddRenewal.';
3014         return;
3015     }
3016
3017     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3018     my $patron_unblessed = $patron->unblessed;
3019
3020     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3021
3022     my $schema = Koha::Database->schema;
3023     $schema->txn_do(sub{
3024
3025         if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3026             _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3027         }
3028         _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3029
3030         # If the due date wasn't specified, calculate it by adding the
3031         # book's loan length to today's date or the current due date
3032         # based on the value of the RenewalPeriodBase syspref.
3033         my $itemtype = $item_object->effective_itemtype;
3034         unless ($datedue) {
3035
3036             $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3037                                             dt_from_string( $issue->date_due, 'sql' ) :
3038                                             dt_from_string();
3039             $datedue =  CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3040         }
3041
3042         my $fees = Koha::Charges::Fees->new(
3043             {
3044                 patron    => $patron,
3045                 library   => $circ_library,
3046                 item      => $item_object,
3047                 from_date => dt_from_string( $issue->date_due, 'sql' ),
3048                 to_date   => dt_from_string($datedue),
3049             }
3050         );
3051
3052         # Update the issues record to have the new due date, and a new count
3053         # of how many times it has been renewed.
3054         my $renews = ( $issue->renewals || 0 ) + 1;
3055         my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
3056                                 WHERE borrowernumber=?
3057                                 AND itemnumber=?"
3058         );
3059
3060         $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
3061
3062         # Update the renewal count on the item, and tell zebra to reindex
3063         $renews = ( $item_object->renewals || 0 ) + 1;
3064         $item_object->renewals($renews);
3065         $item_object->onloan($datedue);
3066         $item_object->store({ log_action => 0 });
3067
3068         # Charge a new rental fee, if applicable
3069         my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3070         if ( $charge > 0 ) {
3071             AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3072         }
3073
3074         # Charge a new accumulate rental fee, if applicable
3075         my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3076         if ( $itemtype_object ) {
3077             my $accumulate_charge = $fees->accumulate_rentalcharge();
3078             if ( $accumulate_charge > 0 ) {
3079                 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3080             }
3081             $charge += $accumulate_charge;
3082         }
3083
3084         # Send a renewal slip according to checkout alert preferencei
3085         if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3086             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3087             my %conditions        = (
3088                 branchcode   => $branch,
3089                 categorycode => $patron->categorycode,
3090                 item_type    => $itemtype,
3091                 notification => 'CHECKOUT',
3092             );
3093             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3094                 SendCirculationAlert(
3095                     {
3096                         type     => 'RENEWAL',
3097                         item     => $item_unblessed,
3098                         borrower => $patron->unblessed,
3099                         branch   => $branch,
3100                     }
3101                 );
3102             }
3103         }
3104
3105         # Remove any OVERDUES related debarment if the borrower has no overdues
3106         if ( $patron
3107           && $patron->is_debarred
3108           && ! $patron->has_overdues
3109           && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3110         ) {
3111             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3112         }
3113
3114         # Add the renewal to stats
3115         UpdateStats(
3116             {
3117                 branch         => $item_object->renewal_branchcode({branch => $branch}),
3118                 type           => 'renew',
3119                 amount         => $charge,
3120                 itemnumber     => $itemnumber,
3121                 itemtype       => $itemtype,
3122                 location       => $item_object->location,
3123                 borrowernumber => $borrowernumber,
3124                 ccode          => $item_object->ccode,
3125             }
3126         );
3127
3128         #Log the renewal
3129         logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3130
3131         Koha::Plugins->call('after_circ_action', {
3132             action  => 'renewal',
3133             payload => {
3134                 checkout  => $issue->get_from_storage
3135             }
3136         });
3137     });
3138
3139     return $datedue;
3140 }
3141
3142 sub GetRenewCount {
3143     # check renewal status
3144     my ( $bornum, $itemno ) = @_;
3145     my $dbh           = C4::Context->dbh;
3146     my $renewcount    = 0;
3147     my $renewsallowed = 0;
3148     my $renewsleft    = 0;
3149
3150     my $patron = Koha::Patrons->find( $bornum );
3151     my $item   = Koha::Items->find($itemno);
3152
3153     return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3154
3155     # Look in the issues table for this item, lent to this borrower,
3156     # and not yet returned.
3157
3158     # FIXME - I think this function could be redone to use only one SQL call.
3159     my $sth = $dbh->prepare(
3160         "select * from issues
3161                                 where (borrowernumber = ?)
3162                                 and (itemnumber = ?)"
3163     );
3164     $sth->execute( $bornum, $itemno );
3165     my $data = $sth->fetchrow_hashref;
3166     $renewcount = $data->{'renewals'} if $data->{'renewals'};
3167     # $item and $borrower should be calculated
3168     my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3169
3170     my $rule = Koha::CirculationRules->get_effective_rule(
3171         {
3172             categorycode => $patron->categorycode,
3173             itemtype     => $item->effective_itemtype,
3174             branchcode   => $branchcode,
3175             rule_name    => 'renewalsallowed',
3176         }
3177     );
3178
3179     $renewsallowed = $rule ? $rule->rule_value : 0;
3180     $renewsleft    = $renewsallowed - $renewcount;
3181     if($renewsleft < 0){ $renewsleft = 0; }
3182     return ( $renewcount, $renewsallowed, $renewsleft );
3183 }
3184
3185 =head2 GetSoonestRenewDate
3186
3187   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3188
3189 Find out the soonest possible renew date of a borrowed item.
3190
3191 C<$borrowernumber> is the borrower number of the patron who currently
3192 has the item on loan.
3193
3194 C<$itemnumber> is the number of the item to renew.
3195
3196 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3197 renew date, based on the value "No renewal before" of the applicable
3198 issuing rule. Returns the current date if the item can already be
3199 renewed, and returns undefined if the borrower, loan, or item
3200 cannot be found.
3201
3202 =cut
3203
3204 sub GetSoonestRenewDate {
3205     my ( $borrowernumber, $itemnumber ) = @_;
3206
3207     my $dbh = C4::Context->dbh;
3208
3209     my $item      = Koha::Items->find($itemnumber)      or return;
3210     my $itemissue = $item->checkout or return;
3211
3212     $borrowernumber ||= $itemissue->borrowernumber;
3213     my $patron = Koha::Patrons->find( $borrowernumber )
3214       or return;
3215
3216     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3217     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3218         {   categorycode => $patron->categorycode,
3219             itemtype     => $item->effective_itemtype,
3220             branchcode   => $branchcode,
3221             rules => [
3222                 'norenewalbefore',
3223                 'lengthunit',
3224             ]
3225         }
3226     );
3227
3228     my $now = dt_from_string;
3229     return $now unless $issuing_rule;
3230
3231     if ( defined $issuing_rule->{norenewalbefore}
3232         and $issuing_rule->{norenewalbefore} ne "" )
3233     {
3234         my $soonestrenewal =
3235           dt_from_string( $itemissue->date_due )->subtract(
3236             $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3237
3238         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3239             and $issuing_rule->{lengthunit} eq 'days' )
3240         {
3241             $soonestrenewal->truncate( to => 'day' );
3242         }
3243         return $soonestrenewal if $now < $soonestrenewal;
3244     }
3245     return $now;
3246 }
3247
3248 =head2 GetLatestAutoRenewDate
3249
3250   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3251
3252 Find out the latest possible auto renew date of a borrowed item.
3253
3254 C<$borrowernumber> is the borrower number of the patron who currently
3255 has the item on loan.
3256
3257 C<$itemnumber> is the number of the item to renew.
3258
3259 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3260 auto renew date, based on the value "No auto renewal after" and the "No auto
3261 renewal after (hard limit) of the applicable issuing rule.
3262 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3263 or item cannot be found.
3264
3265 =cut
3266
3267 sub GetLatestAutoRenewDate {
3268     my ( $borrowernumber, $itemnumber ) = @_;
3269
3270     my $dbh = C4::Context->dbh;
3271
3272     my $item      = Koha::Items->find($itemnumber)  or return;
3273     my $itemissue = $item->checkout                 or return;
3274
3275     $borrowernumber ||= $itemissue->borrowernumber;
3276     my $patron = Koha::Patrons->find( $borrowernumber )
3277       or return;
3278
3279     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3280     my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3281         {
3282             categorycode => $patron->categorycode,
3283             itemtype     => $item->effective_itemtype,
3284             branchcode   => $branchcode,
3285             rules => [
3286                 'no_auto_renewal_after',
3287                 'no_auto_renewal_after_hard_limit',
3288                 'lengthunit',
3289             ]
3290         }
3291     );
3292
3293     return unless $circulation_rules;
3294     return
3295       if ( not $circulation_rules->{no_auto_renewal_after}
3296             or $circulation_rules->{no_auto_renewal_after} eq '' )
3297       and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3298              or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3299
3300     my $maximum_renewal_date;
3301     if ( $circulation_rules->{no_auto_renewal_after} ) {
3302         $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3303         $maximum_renewal_date->add(
3304             $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3305         );
3306     }
3307
3308     if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3309         my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3310         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3311     }
3312     return $maximum_renewal_date;
3313 }
3314
3315
3316 =head2 GetIssuingCharges
3317
3318   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3319
3320 Calculate how much it would cost for a given patron to borrow a given
3321 item, including any applicable discounts.
3322
3323 C<$itemnumber> is the item number of item the patron wishes to borrow.
3324
3325 C<$borrowernumber> is the patron's borrower number.
3326
3327 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3328 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3329 if it's a video).
3330
3331 =cut
3332
3333 sub GetIssuingCharges {
3334
3335     # calculate charges due
3336     my ( $itemnumber, $borrowernumber ) = @_;
3337     my $charge = 0;
3338     my $dbh    = C4::Context->dbh;
3339     my $item_type;
3340
3341     # Get the book's item type and rental charge (via its biblioitem).
3342     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3343         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3344     $charge_query .= (C4::Context->preference('item-level_itypes'))
3345         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3346         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3347
3348     $charge_query .= ' WHERE items.itemnumber =?';
3349
3350     my $sth = $dbh->prepare($charge_query);
3351     $sth->execute($itemnumber);
3352     if ( my $item_data = $sth->fetchrow_hashref ) {
3353         $item_type = $item_data->{itemtype};
3354         $charge    = $item_data->{rentalcharge};
3355         my $branch = C4::Context::mybranch();
3356         my $patron = Koha::Patrons->find( $borrowernumber );
3357         my $discount = _get_discount_from_rule($patron->categorycode, $branch, $item_type);
3358         if ($discount) {
3359             # We may have multiple rules so get the most specific
3360             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3361         }
3362         if ($charge) {
3363             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3364         }
3365     }
3366
3367     return ( $charge, $item_type );
3368 }
3369
3370 # Select most appropriate discount rule from those returned
3371 sub _get_discount_from_rule {
3372     my ($categorycode, $branchcode, $itemtype) = @_;
3373
3374     # Set search precedences
3375     my @params = (
3376         {
3377             branchcode   => $branchcode,
3378             itemtype     => $itemtype,
3379             categorycode => $categorycode,
3380         },
3381         {
3382             branchcode   => undef,
3383             categorycode => $categorycode,
3384             itemtype     => $itemtype,
3385         },
3386         {
3387             branchcode   => $branchcode,
3388             categorycode => $categorycode,
3389             itemtype     => undef,
3390         },
3391         {
3392             branchcode   => undef,
3393             categorycode => $categorycode,
3394             itemtype     => undef,
3395         },
3396     );
3397
3398     foreach my $params (@params) {
3399         my $rule = Koha::CirculationRules->search(
3400             {
3401                 rule_name => 'rentaldiscount',
3402                 %$params,
3403             }
3404         )->next();
3405
3406         return $rule->rule_value if $rule;
3407     }
3408
3409     # none of the above
3410     return 0;
3411 }
3412
3413 =head2 AddIssuingCharge
3414
3415   &AddIssuingCharge( $checkout, $charge, $type )
3416
3417 =cut
3418
3419 sub AddIssuingCharge {
3420     my ( $checkout, $charge, $type ) = @_;
3421
3422     # FIXME What if checkout does not exist?
3423
3424     my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3425     my $accountline = $account->add_debit(
3426         {
3427             amount      => $charge,
3428             note        => undef,
3429             user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3430             library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3431             interface   => C4::Context->interface,
3432             type        => $type,
3433             item_id     => $checkout->itemnumber,
3434             issue_id    => $checkout->issue_id,
3435         }
3436     );
3437 }
3438
3439 =head2 GetTransfers
3440
3441   GetTransfers($itemnumber);
3442
3443 =cut
3444
3445 sub GetTransfers {
3446     my ($itemnumber) = @_;
3447
3448     my $dbh = C4::Context->dbh;
3449
3450     my $query = '
3451         SELECT datesent,
3452                frombranch,
3453                tobranch,
3454                branchtransfer_id
3455         FROM branchtransfers
3456         WHERE itemnumber = ?
3457           AND datearrived IS NULL
3458         ';
3459     my $sth = $dbh->prepare($query);
3460     $sth->execute($itemnumber);
3461     my @row = $sth->fetchrow_array();
3462     return @row;
3463 }
3464
3465 =head2 GetTransfersFromTo
3466
3467   @results = GetTransfersFromTo($frombranch,$tobranch);
3468
3469 Returns the list of pending transfers between $from and $to branch
3470
3471 =cut
3472
3473 sub GetTransfersFromTo {
3474     my ( $frombranch, $tobranch ) = @_;
3475     return unless ( $frombranch && $tobranch );
3476     my $dbh   = C4::Context->dbh;
3477     my $query = "
3478         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3479         FROM   branchtransfers
3480         WHERE  frombranch=?
3481           AND  tobranch=?
3482           AND datearrived IS NULL
3483     ";
3484     my $sth = $dbh->prepare($query);
3485     $sth->execute( $frombranch, $tobranch );
3486     my @gettransfers;
3487
3488     while ( my $data = $sth->fetchrow_hashref ) {
3489         push @gettransfers, $data;
3490     }
3491     return (@gettransfers);
3492 }
3493
3494 =head2 DeleteTransfer
3495
3496   &DeleteTransfer($itemnumber);
3497
3498 =cut
3499
3500 sub DeleteTransfer {
3501     my ($itemnumber) = @_;
3502     return unless $itemnumber;
3503     my $dbh          = C4::Context->dbh;
3504     my $sth          = $dbh->prepare(
3505         "DELETE FROM branchtransfers
3506          WHERE itemnumber=?
3507          AND datearrived IS NULL "
3508     );
3509     return $sth->execute($itemnumber);
3510 }
3511
3512 =head2 SendCirculationAlert
3513
3514 Send out a C<check-in> or C<checkout> alert using the messaging system.
3515
3516 B<Parameters>:
3517
3518 =over 4
3519
3520 =item type
3521
3522 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3523
3524 =item item
3525
3526 Hashref of information about the item being checked in or out.
3527
3528 =item borrower
3529
3530 Hashref of information about the borrower of the item.
3531
3532 =item branch
3533
3534 The branchcode from where the checkout or check-in took place.
3535
3536 =back
3537
3538 B<Example>:
3539
3540     SendCirculationAlert({
3541         type     => 'CHECKOUT',
3542         item     => $item,
3543         borrower => $borrower,
3544         branch   => $branch,
3545     });
3546
3547 =cut
3548
3549 sub SendCirculationAlert {
3550     my ($opts) = @_;
3551     my ($type, $item, $borrower, $branch) =
3552         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3553     my %message_name = (
3554         CHECKIN  => 'Item_Check_in',
3555         CHECKOUT => 'Item_Checkout',
3556         RENEWAL  => 'Item_Checkout',
3557     );
3558     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3559         borrowernumber => $borrower->{borrowernumber},
3560         message_name   => $message_name{$type},
3561     });
3562     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3563
3564     my $schema = Koha::Database->new->schema;
3565     my @transports = keys %{ $borrower_preferences->{transports} };
3566
3567     # From the MySQL doc:
3568     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3569     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3570     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3571     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3572
3573     for my $mtt (@transports) {
3574         my $letter =  C4::Letters::GetPreparedLetter (
3575             module => 'circulation',
3576             letter_code => $type,
3577             branchcode => $branch,
3578             message_transport_type => $mtt,
3579             lang => $borrower->{lang},
3580             tables => {
3581                 $issues_table => $item->{itemnumber},
3582                 'items'       => $item->{itemnumber},
3583                 'biblio'      => $item->{biblionumber},
3584                 'biblioitems' => $item->{biblionumber},
3585                 'borrowers'   => $borrower,
3586                 'branches'    => $branch,
3587             }
3588         ) or next;
3589
3590         $schema->storage->txn_begin;
3591         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3592         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3593         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3594         unless ( $message ) {
3595             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3596             C4::Message->enqueue($letter, $borrower, $mtt);
3597         } else {
3598             $message->append($letter);
3599             $message->update;
3600         }
3601         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3602         $schema->storage->txn_commit;
3603     }
3604
3605     return;
3606 }
3607
3608 =head2 updateWrongTransfer
3609
3610   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3611
3612 This function validate the line of brachtransfer but with the wrong destination (mistake from a librarian ...), and create a new line in branchtransfer from the actual library to the original library of reservation
3613
3614 =cut
3615
3616 sub updateWrongTransfer {
3617         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3618         my $dbh = C4::Context->dbh;
3619 # first step validate the actual line of transfert .
3620         my $sth =
3621                 $dbh->prepare(
3622                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3623                 );
3624                 $sth->execute($FromLibrary,$itemNumber);
3625
3626 # second step create a new line of branchtransfer to the right location .
3627         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3628
3629 #third step changing holdingbranch of item
3630     my $item = Koha::Items->find($itemNumber)->holdingbranch($FromLibrary)->store;
3631 }
3632
3633 =head2 CalcDateDue
3634
3635 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3636
3637 this function calculates the due date given the start date and configured circulation rules,
3638 checking against the holidays calendar as per the daysmode circulation rule.
3639 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3640 C<$itemtype>  = itemtype code of item in question
3641 C<$branch>  = location whose calendar to use
3642 C<$borrower> = Borrower object
3643 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3644
3645 =cut
3646
3647 sub CalcDateDue {
3648     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3649
3650     $isrenewal ||= 0;
3651
3652     # loanlength now a href
3653     my $loanlength =
3654             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3655
3656     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3657             ? qq{renewalperiod}
3658             : qq{issuelength};
3659
3660     my $datedue;
3661     if ( $startdate ) {
3662         if (ref $startdate ne 'DateTime' ) {
3663             $datedue = dt_from_string($datedue);
3664         } else {
3665             $datedue = $startdate->clone;
3666         }
3667     } else {
3668         $datedue = dt_from_string()->truncate( to => 'minute' );
3669     }
3670
3671
3672     my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3673         {
3674             categorycode => $borrower->{categorycode},
3675             itemtype     => $itemtype,
3676             branchcode   => $branch,
3677         }
3678     );
3679
3680     # calculate the datedue as normal
3681     if ( $daysmode eq 'Days' )
3682     {    # ignoring calendar
3683         if ( $loanlength->{lengthunit} eq 'hours' ) {
3684             $datedue->add( hours => $loanlength->{$length_key} );
3685         } else {    # days
3686             $datedue->add( days => $loanlength->{$length_key} );
3687             $datedue->set_hour(23);
3688             $datedue->set_minute(59);
3689         }
3690     } else {
3691         my $dur;
3692         if ($loanlength->{lengthunit} eq 'hours') {
3693             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3694         }
3695         else { # days
3696             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3697         }
3698         my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3699         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3700         if ($loanlength->{lengthunit} eq 'days') {
3701             $datedue->set_hour(23);
3702             $datedue->set_minute(59);
3703         }
3704     }
3705
3706     # if Hard Due Dates are used, retrieve them and apply as necessary
3707     my ( $hardduedate, $hardduedatecompare ) =
3708       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3709     if ($hardduedate) {    # hardduedates are currently dates
3710         $hardduedate->truncate( to => 'minute' );
3711         $hardduedate->set_hour(23);
3712         $hardduedate->set_minute(59);
3713         my $cmp = DateTime->compare( $hardduedate, $datedue );
3714
3715 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3716 # if the calculated date is before the 'after' Hard Due Date (floor), override
3717 # if the hard due date is set to 'exactly', overrride
3718         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3719             $datedue = $hardduedate->clone;
3720         }
3721
3722         # in all other cases, keep the date due as it is
3723
3724     }
3725
3726     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3727     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3728         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3729         if( $expiry_dt ) { #skip empty expiry date..
3730             $expiry_dt->set( hour => 23, minute => 59);
3731             my $d1= $datedue->clone->set_time_zone('floating');
3732             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3733                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3734             }
3735         }
3736         if ( $daysmode ne 'Days' ) {
3737           my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3738           if ( $calendar->is_holiday($datedue) ) {
3739               # Don't return on a closed day
3740               $datedue = $calendar->prev_open_days( $datedue, 1 );
3741           }
3742         }
3743     }
3744
3745     return $datedue;
3746 }
3747
3748
3749 sub CheckValidBarcode{
3750 my ($barcode) = @_;
3751 my $dbh = C4::Context->dbh;
3752 my $query=qq|SELECT count(*)
3753              FROM items
3754              WHERE barcode=?
3755             |;
3756 my $sth = $dbh->prepare($query);
3757 $sth->execute($barcode);
3758 my $exist=$sth->fetchrow ;
3759 return $exist;
3760 }
3761
3762 =head2 IsBranchTransferAllowed
3763
3764   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3765
3766 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3767
3768 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3769 Koha::Item->can_be_transferred.
3770
3771 =cut
3772
3773 sub IsBranchTransferAllowed {
3774         my ( $toBranch, $fromBranch, $code ) = @_;
3775
3776         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3777
3778         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3779         my $dbh = C4::Context->dbh;
3780
3781         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3782         $sth->execute( $toBranch, $fromBranch, $code );
3783         my $limit = $sth->fetchrow_hashref();
3784
3785         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3786         if ( $limit->{'limitId'} ) {
3787                 return 0;
3788         } else {
3789                 return 1;
3790         }
3791 }
3792
3793 =head2 CreateBranchTransferLimit
3794
3795   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3796
3797 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3798
3799 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3800
3801 =cut
3802
3803 sub CreateBranchTransferLimit {
3804    my ( $toBranch, $fromBranch, $code ) = @_;
3805    return unless defined($toBranch) && defined($fromBranch);
3806    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3807
3808    my $dbh = C4::Context->dbh;
3809
3810    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3811    return $sth->execute( $code, $toBranch, $fromBranch );
3812 }
3813
3814 =head2 DeleteBranchTransferLimits
3815
3816     my $result = DeleteBranchTransferLimits($frombranch);
3817
3818 Deletes all the library transfer limits for one library.  Returns the
3819 number of limits deleted, 0e0 if no limits were deleted, or undef if
3820 no arguments are supplied.
3821
3822 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3823     fromBranch => $fromBranch
3824     })->delete.
3825
3826 =cut
3827
3828 sub DeleteBranchTransferLimits {
3829     my $branch = shift;
3830     return unless defined $branch;
3831     my $dbh    = C4::Context->dbh;
3832     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3833     return $sth->execute($branch);
3834 }
3835
3836 sub ReturnLostItem{
3837     my ( $borrowernumber, $itemnum ) = @_;
3838     MarkIssueReturned( $borrowernumber, $itemnum );
3839 }
3840
3841
3842 sub LostItem{
3843     my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3844
3845     unless ( $mark_lost_from ) {
3846         # Temporary check to avoid regressions
3847         die q|LostItem called without $mark_lost_from, check the API.|;
3848     }
3849
3850     my $mark_returned;
3851     if ( $force_mark_returned ) {
3852         $mark_returned = 1;
3853     } else {
3854         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3855         $mark_returned = ( $pref =~ m|$mark_lost_from| );
3856     }
3857
3858     my $dbh = C4::Context->dbh();
3859     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3860                            FROM issues
3861                            JOIN items USING (itemnumber)
3862                            JOIN biblio USING (biblionumber)
3863                            WHERE issues.itemnumber=?");
3864     $sth->execute($itemnumber);
3865     my $issues=$sth->fetchrow_hashref();
3866
3867     # If a borrower lost the item, add a replacement cost to the their record
3868     if ( my $borrowernumber = $issues->{borrowernumber} ){
3869         my $patron = Koha::Patrons->find( $borrowernumber );
3870
3871         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3872         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3873
3874         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3875             C4::Accounts::chargelostitem(
3876                 $borrowernumber,
3877                 $itemnumber,
3878                 $issues->{'replacementprice'},
3879                 sprintf( "%s %s %s",
3880                     $issues->{'title'}          || q{},
3881                     $issues->{'barcode'}        || q{},
3882                     $issues->{'itemcallnumber'} || q{},
3883                 ),
3884             );
3885             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3886             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3887         }
3888
3889         MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3890     }
3891
3892     #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3893     if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3894         Koha::Items->find($itemnumber)->holdingbranch($frombranch)->store;
3895     }
3896     my $transferdeleted = DeleteTransfer($itemnumber);
3897 }
3898
3899 sub GetOfflineOperations {
3900     my $dbh = C4::Context->dbh;
3901     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3902     $sth->execute(C4::Context->userenv->{'branch'});
3903     my $results = $sth->fetchall_arrayref({});
3904     return $results;
3905 }
3906
3907 sub GetOfflineOperation {
3908     my $operationid = shift;
3909     return unless $operationid;
3910     my $dbh = C4::Context->dbh;
3911     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3912     $sth->execute( $operationid );
3913     return $sth->fetchrow_hashref;
3914 }
3915
3916 sub AddOfflineOperation {
3917     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3918     my $dbh = C4::Context->dbh;
3919     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3920     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3921     return "Added.";
3922 }
3923
3924 sub DeleteOfflineOperation {
3925     my $dbh = C4::Context->dbh;
3926     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3927     $sth->execute( shift );
3928     return "Deleted.";
3929 }
3930
3931 sub ProcessOfflineOperation {
3932     my $operation = shift;
3933
3934     my $report;
3935     if ( $operation->{action} eq 'return' ) {
3936         $report = ProcessOfflineReturn( $operation );
3937     } elsif ( $operation->{action} eq 'issue' ) {
3938         $report = ProcessOfflineIssue( $operation );
3939     } elsif ( $operation->{action} eq 'payment' ) {
3940         $report = ProcessOfflinePayment( $operation );
3941     }
3942
3943     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3944
3945     return $report;
3946 }
3947
3948 sub ProcessOfflineReturn {
3949     my $operation = shift;
3950
3951     my $item = Koha::Items->find({barcode => $operation->{barcode}});
3952
3953     if ( $item ) {
3954         my $itemnumber = $item->itemnumber;
3955         my $issue = GetOpenIssue( $itemnumber );
3956         if ( $issue ) {
3957             my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3958             ModDateLastSeen( $itemnumber, $leave_item_lost );
3959             MarkIssueReturned(
3960                 $issue->{borrowernumber},
3961                 $itemnumber,
3962                 $operation->{timestamp},
3963             );
3964             $item->renewals(0);
3965             $item->onloan(undef);
3966             $item->store({ log_action => 0 });
3967             return "Success.";
3968         } else {
3969             return "Item not issued.";
3970         }
3971     } else {
3972         return "Item not found.";
3973     }
3974 }
3975
3976 sub ProcessOfflineIssue {
3977     my $operation = shift;
3978
3979     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3980
3981     if ( $patron ) {
3982         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3983         unless ($item) {
3984             return "Barcode not found.";
3985         }
3986         my $itemnumber = $item->itemnumber;
3987         my $issue = GetOpenIssue( $itemnumber );
3988
3989         if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3990             MarkIssueReturned(
3991                 $issue->{borrowernumber},
3992                 $itemnumber,
3993                 $operation->{timestamp},
3994             );
3995         }
3996         AddIssue(
3997             $patron->unblessed,
3998             $operation->{'barcode'},
3999             undef,
4000             1,
4001             $operation->{timestamp},
4002             undef,
4003         );
4004         return "Success.";
4005     } else {
4006         return "Borrower not found.";
4007     }
4008 }
4009
4010 sub ProcessOfflinePayment {
4011     my $operation = shift;
4012
4013     my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4014
4015     $patron->account->pay(
4016         {
4017             amount     => $operation->{amount},
4018             library_id => $operation->{branchcode},
4019             interface  => 'koc'
4020         }
4021     );
4022
4023     return "Success.";
4024 }
4025
4026 =head2 TransferSlip
4027
4028   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4029
4030   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4031
4032 =cut
4033
4034 sub TransferSlip {
4035     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4036
4037     my $item =
4038       $itemnumber
4039       ? Koha::Items->find($itemnumber)
4040       : Koha::Items->find( { barcode => $barcode } );
4041
4042     $item or return;
4043
4044     return C4::Letters::GetPreparedLetter (
4045         module => 'circulation',
4046         letter_code => 'TRANSFERSLIP',
4047         branchcode => $branch,
4048         tables => {
4049             'branches'    => $to_branch,
4050             'biblio'      => $item->biblionumber,
4051             'items'       => $item->unblessed,
4052         },
4053     );
4054 }
4055
4056 =head2 CheckIfIssuedToPatron
4057
4058   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4059
4060   Return 1 if any record item is issued to patron, otherwise return 0
4061
4062 =cut
4063
4064 sub CheckIfIssuedToPatron {
4065     my ($borrowernumber, $biblionumber) = @_;
4066
4067     my $dbh = C4::Context->dbh;
4068     my $query = q|
4069         SELECT COUNT(*) FROM issues
4070         LEFT JOIN items ON items.itemnumber = issues.itemnumber
4071         WHERE items.biblionumber = ?
4072         AND issues.borrowernumber = ?
4073     |;
4074     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4075     return 1 if $is_issued;
4076     return;
4077 }
4078
4079 =head2 IsItemIssued
4080
4081   IsItemIssued( $itemnumber )
4082
4083   Return 1 if the item is on loan, otherwise return 0
4084
4085 =cut
4086
4087 sub IsItemIssued {
4088     my $itemnumber = shift;
4089     my $dbh = C4::Context->dbh;
4090     my $sth = $dbh->prepare(q{
4091         SELECT COUNT(*)
4092         FROM issues
4093         WHERE itemnumber = ?
4094     });
4095     $sth->execute($itemnumber);
4096     return $sth->fetchrow;
4097 }
4098
4099 =head2 GetAgeRestriction
4100
4101   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4102   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4103
4104   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4105   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4106
4107 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4108 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4109 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4110          Negative days mean the borrower has gone past the age restriction age.
4111
4112 =cut
4113
4114 sub GetAgeRestriction {
4115     my ($record_restrictions, $borrower) = @_;
4116     my $markers = C4::Context->preference('AgeRestrictionMarker');
4117
4118     return unless $record_restrictions;
4119     # Split $record_restrictions to something like FSK 16 or PEGI 6
4120     my @values = split ' ', uc($record_restrictions);
4121     return unless @values;
4122
4123     # Search first occurrence of one of the markers
4124     my @markers = split /\|/, uc($markers);
4125     return unless @markers;
4126
4127     my $index            = 0;
4128     my $restriction_year = 0;
4129     for my $value (@values) {
4130         $index++;
4131         for my $marker (@markers) {
4132             $marker =~ s/^\s+//;    #remove leading spaces
4133             $marker =~ s/\s+$//;    #remove trailing spaces
4134             if ( $marker eq $value ) {
4135                 if ( $index <= $#values ) {
4136                     $restriction_year += $values[$index];
4137                 }
4138                 last;
4139             }
4140             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4141
4142                 # Perhaps it is something like "K16" (as in Finland)
4143                 $restriction_year += $1;
4144                 last;
4145             }
4146         }
4147         last if ( $restriction_year > 0 );
4148     }
4149
4150     #Check if the borrower is age restricted for this material and for how long.
4151     if ($restriction_year && $borrower) {
4152         if ( $borrower->{'dateofbirth'} ) {
4153             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4154             $alloweddate[0] += $restriction_year;
4155
4156             #Prevent runime eror on leap year (invalid date)
4157             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4158                 $alloweddate[2] = 28;
4159             }
4160
4161             #Get how many days the borrower has to reach the age restriction
4162             my @Today = split /-/, dt_from_string()->ymd();
4163             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4164             #Negative days means the borrower went past the age restriction age
4165             return ($restriction_year, $daysToAgeRestriction);
4166         }
4167     }
4168
4169     return ($restriction_year);
4170 }
4171
4172
4173 =head2 GetPendingOnSiteCheckouts
4174
4175 =cut
4176
4177 sub GetPendingOnSiteCheckouts {
4178     my $dbh = C4::Context->dbh;
4179     return $dbh->selectall_arrayref(q|
4180         SELECT
4181           items.barcode,
4182           items.biblionumber,
4183           items.itemnumber,
4184           items.itemnotes,
4185           items.itemcallnumber,
4186           items.location,
4187           issues.date_due,
4188           issues.branchcode,
4189           issues.date_due < NOW() AS is_overdue,
4190           biblio.author,
4191           biblio.title,
4192           borrowers.firstname,
4193           borrowers.surname,
4194           borrowers.cardnumber,
4195           borrowers.borrowernumber
4196         FROM items
4197         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4198         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4199         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4200         WHERE issues.onsite_checkout = 1
4201     |, { Slice => {} } );
4202 }
4203
4204 sub GetTopIssues {
4205     my ($params) = @_;
4206
4207     my ($count, $branch, $itemtype, $ccode, $newness)
4208         = @$params{qw(count branch itemtype ccode newness)};
4209
4210     my $dbh = C4::Context->dbh;
4211     my $query = q{
4212         SELECT * FROM (
4213         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4214           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4215           i.ccode, SUM(i.issues) AS count
4216         FROM biblio b
4217         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4218         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4219     };
4220
4221     my (@where_strs, @where_args);
4222
4223     if ($branch) {
4224         push @where_strs, 'i.homebranch = ?';
4225         push @where_args, $branch;
4226     }
4227     if ($itemtype) {
4228         if (C4::Context->preference('item-level_itypes')){
4229             push @where_strs, 'i.itype = ?';
4230             push @where_args, $itemtype;
4231         } else {
4232             push @where_strs, 'bi.itemtype = ?';
4233             push @where_args, $itemtype;
4234         }
4235     }
4236     if ($ccode) {
4237         push @where_strs, 'i.ccode = ?';
4238         push @where_args, $ccode;
4239     }
4240     if ($newness) {
4241         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4242         push @where_args, $newness;
4243     }
4244
4245     if (@where_strs) {
4246         $query .= 'WHERE ' . join(' AND ', @where_strs);
4247     }
4248
4249     $query .= q{
4250         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4251           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4252           i.ccode
4253         ORDER BY count DESC
4254     };
4255
4256     $query .= q{ ) xxx WHERE count > 0 };
4257     $count = int($count);
4258     if ($count > 0) {
4259         $query .= "LIMIT $count";
4260     }
4261
4262     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4263
4264     return @$rows;
4265 }
4266
4267 =head2 Internal methods
4268
4269 =cut
4270
4271 sub _CalculateAndUpdateFine {
4272     my ($params) = @_;
4273
4274     my $borrower    = $params->{borrower};
4275     my $item        = $params->{item};
4276     my $issue       = $params->{issue};
4277     my $return_date = $params->{return_date};
4278
4279     unless ($borrower) { carp "No borrower passed in!" && return; }
4280     unless ($item)     { carp "No item passed in!"     && return; }
4281     unless ($issue)    { carp "No issue passed in!"    && return; }
4282
4283     my $datedue = dt_from_string( $issue->date_due );
4284
4285     # we only need to calculate and change the fines if we want to do that on return
4286     # Should be on for hourly loans
4287     my $control = C4::Context->preference('CircControl');
4288     my $control_branchcode =
4289         ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4290       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4291       :                                     $issue->branchcode;
4292
4293     my $date_returned = $return_date ? $return_date : dt_from_string();
4294
4295     my ( $amount, $unitcounttotal, $unitcount  ) =
4296       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4297
4298     if ( C4::Context->preference('finesMode') eq 'production' ) {
4299         if ( $amount > 0 ) {
4300             C4::Overdues::UpdateFine({
4301                 issue_id       => $issue->issue_id,
4302                 itemnumber     => $issue->itemnumber,
4303                 borrowernumber => $issue->borrowernumber,
4304                 amount         => $amount,
4305                 due            => output_pref($datedue),
4306             });
4307         }
4308         elsif ($return_date) {
4309
4310             # Backdated returns may have fines that shouldn't exist,
4311             # so in this case, we need to drop those fines to 0
4312
4313             C4::Overdues::UpdateFine({
4314                 issue_id       => $issue->issue_id,
4315                 itemnumber     => $issue->itemnumber,
4316                 borrowernumber => $issue->borrowernumber,
4317                 amount         => 0,
4318                 due            => output_pref($datedue),
4319             });
4320         }
4321     }
4322 }
4323
4324 sub _item_denied_renewal {
4325     my ($params) = @_;
4326
4327     my $item = $params->{item};
4328     return unless $item;
4329
4330     my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4331     return unless $denyingrules;
4332     foreach my $field (keys %$denyingrules) {
4333         my $val = $item->$field;
4334         if( !defined $val) {
4335             if ( any { !defined $_ }  @{$denyingrules->{$field}} ){
4336                 return 1;
4337             }
4338         } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4339            # If the results matches the values in the syspref
4340            # We return true if match found
4341             return 1;
4342         }
4343     }
4344     return 0;
4345 }
4346
4347 1;
4348
4349 __END__
4350
4351 =head1 AUTHOR
4352
4353 Koha Development Team <http://koha-community.org/>
4354
4355 =cut