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::RefundLostItemFeeRules;
  56 use Koha::Account::Lines;
  57 use Koha::Account::Offsets;
  58 use Koha::Config::SysPrefs;
  59 use Koha::Charges::Fees;
  60 use Koha::Util::SystemPreferences;
  61 use Koha::Checkouts::ReturnClaims;
  62 use Carp;
  63 use List::MoreUtils qw( uniq any );
  64 use Scalar::Util qw( looks_like_number );
  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
1473                     && Koha::RefundLostItemFeeRules->should_refund(
1474                         {
1475                             current_branch   => C4::Context->userenv->{branch},
1476                             item_home_branch => $item_object->homebranch,
1477                             item_holding_branch => $item_object->holdingbranch,
1478                         }
1479                     )
1480                   )
1481                 {
1482                     _FixAccountForLostAndFound( $item_object->itemnumber, undef,
1483                         $item_object->barcode );
1484                 }
1485             }
1486
1487             $item_object->issues( ( $item_object->issues || 0 ) + 1);
1488             $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1489             $item_object->itemlost(0);
1490             $item_object->onloan($datedue->ymd());
1491             $item_object->datelastborrowed( dt_from_string()->ymd() );
1492             $item_object->store({log_action => 0});
1493             ModDateLastSeen( $item_object->itemnumber );
1494
1495             # If it costs to borrow this book, charge it to the patron's account.
1496             my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1497             if ( $charge && $charge > 0 ) {
1498                 AddIssuingCharge( $issue, $charge, 'RENT' );
1499             }
1500
1501             my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1502             if ( $itemtype_object ) {
1503                 my $accumulate_charge = $fees->accumulate_rentalcharge();
1504                 if ( $accumulate_charge > 0 ) {
1505                     AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1506                     $charge += $accumulate_charge;
1507                     $item_unblessed->{charge} = $charge;
1508                 }
1509             }
1510
1511             # Record the fact that this book was issued.
1512             &UpdateStats(
1513                 {
1514                     branch => C4::Context->userenv->{'branch'},
1515                     type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1516                     amount         => $charge,
1517                     other          => ( $sipmode ? "SIP-$sipmode" : '' ),
1518                     itemnumber     => $item_object->itemnumber,
1519                     itemtype       => $item_object->effective_itemtype,
1520                     location       => $item_object->location,
1521                     borrowernumber => $borrower->{'borrowernumber'},
1522                     ccode          => $item_object->ccode,
1523                 }
1524             );
1525
1526             # Send a checkout slip.
1527             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1528             my %conditions        = (
1529                 branchcode   => $branchcode,
1530                 categorycode => $borrower->{categorycode},
1531                 item_type    => $item_object->effective_itemtype,
1532                 notification => 'CHECKOUT',
1533             );
1534             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1535                 SendCirculationAlert(
1536                     {
1537                         type     => 'CHECKOUT',
1538                         item     => $item_object->unblessed,
1539                         borrower => $borrower,
1540                         branch   => $branchcode,
1541                     }
1542                 );
1543             }
1544             logaction(
1545                 "CIRCULATION", "ISSUE",
1546                 $borrower->{'borrowernumber'},
1547                 $item_object->itemnumber,
1548             ) if C4::Context->preference("IssueLog");
1549         }
1550     }
1551     return $issue;
1552 }
1553
1554 =head2 GetLoanLength
1555
1556   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1557
1558 Get loan length for an itemtype, a borrower type and a branch
1559
1560 =cut
1561
1562 sub GetLoanLength {
1563     my ( $categorycode, $itemtype, $branchcode ) = @_;
1564
1565     # Set search precedences
1566     my @params = (
1567         {
1568             categorycode => $categorycode,
1569             itemtype     => $itemtype,
1570             branchcode   => $branchcode,
1571         },
1572         {
1573             categorycode => $categorycode,
1574             itemtype     => undef,
1575             branchcode   => $branchcode,
1576         },
1577         {
1578             categorycode => undef,
1579             itemtype     => $itemtype,
1580             branchcode   => $branchcode,
1581         },
1582         {
1583             categorycode => undef,
1584             itemtype     => undef,
1585             branchcode   => $branchcode,
1586         },
1587         {
1588             categorycode => $categorycode,
1589             itemtype     => $itemtype,
1590             branchcode   => undef,
1591         },
1592         {
1593             categorycode => $categorycode,
1594             itemtype     => undef,
1595             branchcode   => undef,
1596         },
1597         {
1598             categorycode => undef,
1599             itemtype     => $itemtype,
1600             branchcode   => undef,
1601         },
1602         {
1603             categorycode => undef,
1604             itemtype     => undef,
1605             branchcode   => undef,
1606         },
1607     );
1608
1609     # Initialize default values
1610     my $rules = {
1611         issuelength   => 0,
1612         renewalperiod => 0,
1613         lengthunit    => 'days',
1614     };
1615
1616     # Search for rules!
1617     foreach my $rule_name (qw( issuelength renewalperiod lengthunit )) {
1618         foreach my $params (@params) {
1619             my $rule = Koha::CirculationRules->search(
1620                 {
1621                     rule_name => $rule_name,
1622                     %$params,
1623                 }
1624             )->next();
1625
1626             if ($rule) {
1627                 $rules->{$rule_name} = $rule->rule_value;
1628                 last;
1629             }
1630         }
1631     }
1632
1633     return $rules;
1634 }
1635
1636
1637 =head2 GetHardDueDate
1638
1639   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1640
1641 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1642
1643 =cut
1644
1645 sub GetHardDueDate {
1646     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1647
1648     my $rules = Koha::CirculationRules->get_effective_rules(
1649         {
1650             categorycode => $borrowertype,
1651             itemtype     => $itemtype,
1652             branchcode   => $branchcode,
1653             rules        => [ 'hardduedate', 'hardduedatecompare' ],
1654         }
1655     );
1656
1657     if ( defined( $rules->{hardduedate} ) ) {
1658         if ( $rules->{hardduedate} ) {
1659             return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1660         }
1661         else {
1662             return ( undef, undef );
1663         }
1664     }
1665 }
1666
1667 =head2 GetBranchBorrowerCircRule
1668
1669   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1670
1671 Retrieves circulation rule attributes that apply to the given
1672 branch and patron category, regardless of item type.
1673 The return value is a hashref containing the following key:
1674
1675 patron_maxissueqty - maximum number of loans that a
1676 patron of the given category can have at the given
1677 branch.  If the value is undef, no limit.
1678
1679 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1680 patron of the given category can have at the given
1681 branch.  If the value is undef, no limit.
1682
1683 This will check for different branch/category combinations in the following order:
1684 branch and category
1685 branch only
1686 category only
1687 default branch and category
1688
1689 If no rule has been found in the database, it will default to
1690 the buillt in rule:
1691
1692 patron_maxissueqty - undef
1693 patron_maxonsiteissueqty - undef
1694
1695 C<$branchcode> and C<$categorycode> should contain the
1696 literal branch code and patron category code, respectively - no
1697 wildcards.
1698
1699 =cut
1700
1701 sub GetBranchBorrowerCircRule {
1702     my ( $branchcode, $categorycode ) = @_;
1703
1704     # Initialize default values
1705     my $rules = {
1706         patron_maxissueqty       => undef,
1707         patron_maxonsiteissueqty => undef,
1708     };
1709
1710     # Search for rules!
1711     foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1712         my $rule = Koha::CirculationRules->get_effective_rule(
1713             {
1714                 categorycode => $categorycode,
1715                 itemtype     => undef,
1716                 branchcode   => $branchcode,
1717                 rule_name    => $rule_name,
1718             }
1719         );
1720
1721         $rules->{$rule_name} = $rule->rule_value if defined $rule;
1722     }
1723
1724     return $rules;
1725 }
1726
1727 =head2 GetBranchItemRule
1728
1729   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1730
1731 Retrieves circulation rule attributes that apply to the given
1732 branch and item type, regardless of patron category.
1733
1734 The return value is a hashref containing the following keys:
1735
1736 holdallowed => Hold policy for this branch and itemtype. Possible values:
1737   0: No holds allowed.
1738   1: Holds allowed only by patrons that have the same homebranch as the item.
1739   2: Holds allowed from any patron.
1740
1741 returnbranch => branch to which to return item.  Possible values:
1742   noreturn: do not return, let item remain where checked in (floating collections)
1743   homebranch: return to item's home branch
1744   holdingbranch: return to issuer branch
1745
1746 This searches branchitemrules in the following order:
1747
1748   * Same branchcode and itemtype
1749   * Same branchcode, itemtype '*'
1750   * branchcode '*', same itemtype
1751   * branchcode and itemtype '*'
1752
1753 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1754
1755 =cut
1756
1757 sub GetBranchItemRule {
1758     my ( $branchcode, $itemtype ) = @_;
1759
1760     # Search for rules!
1761     my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1762         {
1763             branchcode => $branchcode,
1764             itemtype => $itemtype,
1765             rule_name => 'holdallowed',
1766         }
1767     );
1768     my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1769         {
1770             branchcode => $branchcode,
1771             itemtype => $itemtype,
1772             rule_name => 'hold_fulfillment_policy',
1773         }
1774     );
1775     my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1776         {
1777             branchcode => $branchcode,
1778             itemtype => $itemtype,
1779             rule_name => 'returnbranch',
1780         }
1781     );
1782
1783     # built-in default circulation rule
1784     my $rules;
1785     $rules->{holdallowed} = defined $holdallowed_rule
1786         ? $holdallowed_rule->rule_value
1787         : 2;
1788     $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1789         ? $hold_fulfillment_policy_rule->rule_value
1790         : 'any';
1791     $rules->{returnbranch} = defined $returnbranch_rule
1792         ? $returnbranch_rule->rule_value
1793         : 'homebranch';
1794
1795     return $rules;
1796 }
1797
1798 =head2 AddReturn
1799
1800   ($doreturn, $messages, $iteminformation, $borrower) =
1801       &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1802
1803 Returns a book.
1804
1805 =over 4
1806
1807 =item C<$barcode> is the bar code of the book being returned.
1808
1809 =item C<$branch> is the code of the branch where the book is being returned.
1810
1811 =item C<$exemptfine> indicates that overdue charges for the item will be
1812 removed. Optional.
1813
1814 =item C<$return_date> allows the default return date to be overridden
1815 by the given return date. Optional.
1816
1817 =back
1818
1819 C<&AddReturn> returns a list of four items:
1820
1821 C<$doreturn> is true iff the return succeeded.
1822
1823 C<$messages> is a reference-to-hash giving feedback on the operation.
1824 The keys of the hash are:
1825
1826 =over 4
1827
1828 =item C<BadBarcode>
1829
1830 No item with this barcode exists. The value is C<$barcode>.
1831
1832 =item C<NotIssued>
1833
1834 The book is not currently on loan. The value is C<$barcode>.
1835
1836 =item C<withdrawn>
1837
1838 This book has been withdrawn/cancelled. The value should be ignored.
1839
1840 =item C<Wrongbranch>
1841
1842 This book has was returned to the wrong branch.  The value is a hashref
1843 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1844 contain the branchcode of the incorrect and correct return library, respectively.
1845
1846 =item C<ResFound>
1847
1848 The item was reserved. The value is a reference-to-hash whose keys are
1849 fields from the reserves table of the Koha database, and
1850 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1851 either C<Waiting>, C<Reserved>, or 0.
1852
1853 =item C<WasReturned>
1854
1855 Value 1 if return is successful.
1856
1857 =item C<NeedsTransfer>
1858
1859 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1860
1861 =back
1862
1863 C<$iteminformation> is a reference-to-hash, giving information about the
1864 returned item from the issues table.
1865
1866 C<$borrower> is a reference-to-hash, giving information about the
1867 patron who last borrowed the book.
1868
1869 =cut
1870
1871 sub AddReturn {
1872     my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1873
1874     if ($branch and not Koha::Libraries->find($branch)) {
1875         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1876         undef $branch;
1877     }
1878     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1879     my $return_date_specified = !!$return_date;
1880     $return_date //= dt_from_string();
1881     my $messages;
1882     my $patron;
1883     my $doreturn       = 1;
1884     my $validTransfert = 0;
1885     my $stat_type = 'return';
1886
1887     # get information on item
1888     my $item = Koha::Items->find({ barcode => $barcode });
1889     unless ($item) {
1890         return ( 0, { BadBarcode => $barcode } );    # no barcode means no item or borrower.  bail out.
1891     }
1892
1893     my $itemnumber = $item->itemnumber;
1894     my $itemtype = $item->effective_itemtype;
1895
1896     my $issue  = $item->checkout;
1897     if ( $issue ) {
1898         $patron = $issue->patron
1899             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1900                 . Dumper($issue->unblessed) . "\n";
1901     } else {
1902         $messages->{'NotIssued'} = $barcode;
1903         $item->onloan(undef)->store if defined $item->onloan;
1904
1905         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1906         $doreturn = 0;
1907         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1908         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1909         if (C4::Context->preference("RecordLocalUseOnReturn")) {
1910            $messages->{'LocalUse'} = 1;
1911            $stat_type = 'localuse';
1912         }
1913     }
1914
1915         # full item data, but no borrowernumber or checkout info (no issue)
1916     my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1917         # get the proper branch to which to return the item
1918     my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1919         # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1920     my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
1921
1922     my $borrowernumber = $patron ? $patron->borrowernumber : undef;    # we don't know if we had a borrower or not
1923     my $patron_unblessed = $patron ? $patron->unblessed : {};
1924
1925     my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1926     map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1927     if ($update_loc_rules) {
1928         if (defined $update_loc_rules->{_ALL_}) {
1929             if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1930             if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1931             if ( $item->location ne $update_loc_rules->{_ALL_}) {
1932                 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1933                 $item->location($update_loc_rules->{_ALL_})->store;
1934             }
1935         }
1936         else {
1937             foreach my $key ( keys %$update_loc_rules ) {
1938                 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1939                 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1940                 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1941                     $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
1942                     $item->location($update_loc_rules->{$key})->store;
1943                     last;
1944                 }
1945             }
1946         }
1947     }
1948
1949     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1950     if ($yaml) {
1951         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
1952         my $rules;
1953         eval { $rules = YAML::Load($yaml); };
1954         if ($@) {
1955             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1956         }
1957         else {
1958             foreach my $key ( keys %$rules ) {
1959                 if ( $item->notforloan eq $key ) {
1960                     $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1961                     $item->notforloan($rules->{$key})->store({ log_action => 0 });
1962                     last;
1963                 }
1964             }
1965         }
1966     }
1967
1968     # check if the return is allowed at this branch
1969     my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
1970     unless ($returnallowed){
1971         $messages->{'Wrongbranch'} = {
1972             Wrongbranch => $branch,
1973             Rightbranch => $message
1974         };
1975         $doreturn = 0;
1976         return ( $doreturn, $messages, $issue, $patron_unblessed);
1977     }
1978
1979     if ( $item->withdrawn ) { # book has been cancelled
1980         $messages->{'withdrawn'} = 1;
1981         $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1982     }
1983
1984     if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1985         $doreturn = 0;
1986     }
1987
1988     # case of a return of document (deal with issues and holdingbranch)
1989     if ($doreturn) {
1990         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1991         $patron or warn "AddReturn without current borrower";
1992
1993         if ($patron) {
1994             eval {
1995                 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
1996             };
1997             unless ( $@ ) {
1998                 if (
1999                     (
2000                         C4::Context->preference('CalculateFinesOnReturn')
2001                         || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2002                     )
2003                     && !$item->itemlost
2004                   )
2005                 {
2006                     _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2007                 }
2008             } else {
2009                 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 );
2010
2011                 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2012             }
2013
2014             # FIXME is the "= 1" right?  This could be the borrower hash.
2015             $messages->{'WasReturned'} = 1;
2016
2017         }
2018
2019         $item->onloan(undef)->store({ log_action => 0 });
2020     }
2021
2022     # the holdingbranch is updated if the document is returned to another location.
2023     # this is always done regardless of whether the item was on loan or not
2024     my $item_holding_branch = $item->holdingbranch;
2025     if ($item->holdingbranch ne $branch) {
2026         $item->holdingbranch($branch)->store;
2027     }
2028
2029     my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2030     ModDateLastSeen( $item->itemnumber, $leave_item_lost );
2031
2032     # check if we have a transfer for this document
2033     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
2034
2035     # if we have a transfer to do, we update the line of transfers with the datearrived
2036     my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
2037     if ($datesent) {
2038         if ( $tobranch eq $branch ) {
2039             my $sth = C4::Context->dbh->prepare(
2040                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2041             );
2042             $sth->execute( $item->itemnumber );
2043         } else {
2044             $messages->{'WrongTransfer'}     = $tobranch;
2045             $messages->{'WrongTransferItem'} = $item->itemnumber;
2046         }
2047         $validTransfert = 1;
2048     }
2049
2050     # fix up the accounts.....
2051     if ( $item->itemlost ) {
2052         $messages->{'WasLost'} = 1;
2053         unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2054             my $refund = 1;
2055             my $no_refund_after_days = C4::Context->preference('NoRefundOnLostReturnedItemsAge');
2056             if ($no_refund_after_days) {
2057                 my $today = dt_from_string();
2058                 my $lost_age_in_days =
2059                   dt_from_string( $item->itemlost_on )
2060                   ->delta_days($today)
2061                   ->in_units('days');
2062
2063                 $refund = 0 unless ( $lost_age_in_days < $no_refund_after_days );
2064             }
2065
2066             if (
2067                 $refund &&
2068                 Koha::RefundLostItemFeeRules->should_refund(
2069                     {
2070                         current_branch      => C4::Context->userenv->{branch},
2071                         item_home_branch    => $item->homebranch,
2072                         item_holding_branch => $item_holding_branch
2073                     }
2074                 )
2075               )
2076             {
2077                 _FixAccountForLostAndFound( $item->itemnumber,
2078                     $borrowernumber, $barcode );
2079                 $messages->{'LostItemFeeRefunded'} = 1;
2080             }
2081         }
2082     }
2083
2084     # fix up the overdues in accounts...
2085     if ($borrowernumber) {
2086         my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2087         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!";  # zero is OK, check defined
2088
2089         if ( $issue and $issue->is_overdue($return_date) ) {
2090         # fix fine days
2091             my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2092             if ($reminder){
2093                 $messages->{'PrevDebarred'} = $debardate;
2094             } else {
2095                 $messages->{'Debarred'} = $debardate if $debardate;
2096             }
2097         # there's no overdue on the item but borrower had been previously debarred
2098         } elsif ( $issue->date_due and $patron->debarred ) {
2099              if ( $patron->debarred eq "9999-12-31") {
2100                 $messages->{'ForeverDebarred'} = $patron->debarred;
2101              } else {
2102                   my $borrower_debar_dt = dt_from_string( $patron->debarred );
2103                   $borrower_debar_dt->truncate(to => 'day');
2104                   my $today_dt = $return_date->clone()->truncate(to => 'day');
2105                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2106                       $messages->{'PrevDebarred'} = $patron->debarred;
2107                   }
2108              }
2109         }
2110     }
2111
2112     # find reserves.....
2113     # launch the Checkreserves routine to find any holds
2114     my ($resfound, $resrec);
2115     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2116     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2117     # 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)
2118     if ( $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2119         my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2120         $resfound = 'Reserved';
2121         $resrec = $hold->unblessed;
2122     }
2123     if ($resfound) {
2124           $resrec->{'ResFound'} = $resfound;
2125         $messages->{'ResFound'} = $resrec;
2126     }
2127
2128     # Record the fact that this book was returned.
2129     UpdateStats({
2130         branch         => $branch,
2131         type           => $stat_type,
2132         itemnumber     => $itemnumber,
2133         itemtype       => $itemtype,
2134         location       => $item->location,
2135         borrowernumber => $borrowernumber,
2136         ccode          => $item->ccode,
2137     });
2138
2139     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2140     if ( $patron ) {
2141         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2142         my %conditions = (
2143             branchcode   => $branch,
2144             categorycode => $patron->categorycode,
2145             item_type    => $itemtype,
2146             notification => 'CHECKIN',
2147         );
2148         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2149             SendCirculationAlert({
2150                 type     => 'CHECKIN',
2151                 item     => $item->unblessed,
2152                 borrower => $patron->unblessed,
2153                 branch   => $branch,
2154             });
2155         }
2156
2157         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2158             if C4::Context->preference("ReturnLog");
2159         }
2160
2161     # Check if this item belongs to a biblio record that is attached to an
2162     # ILL request, if it is we need to update the ILL request's status
2163     if (C4::Context->preference('CirculateILL')) {
2164         my $request = Koha::Illrequests->find(
2165             { biblio_id => $item->biblio->biblionumber }
2166         );
2167         $request->status('RET') if $request;
2168     }
2169
2170     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2171     if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2172         my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2173         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2174             (C4::Context->preference("UseBranchTransferLimits") and
2175              ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2176            )) {
2177             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s, %s)", $item->itemnumber,$branch, $returnbranch, $transfer_trigger;
2178             $debug and warn "item: " . Dumper($item->unblessed);
2179             ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger);
2180             $messages->{'WasTransfered'} = 1;
2181         } else {
2182             $messages->{'NeedsTransfer'} = $returnbranch;
2183             $messages->{'TransferTrigger'} = $transfer_trigger;
2184         }
2185     }
2186
2187     if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2188         my $claims = Koha::Checkouts::ReturnClaims->search(
2189            {
2190                itemnumber => $item->id,
2191                resolution => undef,
2192            }
2193         );
2194
2195         if ( $claims->count ) {
2196             $messages->{ReturnClaims} = $claims;
2197         }
2198     }
2199
2200     return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2201 }
2202
2203 =head2 MarkIssueReturned
2204
2205   MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2206
2207 Unconditionally marks an issue as being returned by
2208 moving the C<issues> row to C<old_issues> and
2209 setting C<returndate> to the current date.
2210
2211 if C<$returndate> is specified (in iso format), it is used as the date
2212 of the return.
2213
2214 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2215 the old_issue is immediately anonymised
2216
2217 Ideally, this function would be internal to C<C4::Circulation>,
2218 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2219 and offline_circ/process_koc.pl.
2220
2221 =cut
2222
2223 sub MarkIssueReturned {
2224     my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2225
2226     # Retrieve the issue
2227     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2228
2229     return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2230
2231     my $issue_id = $issue->issue_id;
2232
2233     my $anonymouspatron;
2234     if ( $privacy && $privacy == 2 ) {
2235         # The default of 0 will not work due to foreign key constraints
2236         # The anonymisation will fail if AnonymousPatron is not a valid entry
2237         # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2238         # Note that a warning should appear on the about page (System information tab).
2239         $anonymouspatron = C4::Context->preference('AnonymousPatron');
2240         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."
2241             unless Koha::Patrons->find( $anonymouspatron );
2242     }
2243
2244     my $schema = Koha::Database->schema;
2245
2246     # FIXME Improve the return value and handle it from callers
2247     $schema->txn_do(sub {
2248
2249         my $patron = Koha::Patrons->find( $borrowernumber );
2250
2251         # Update the returndate value
2252         if ( $returndate ) {
2253             $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2254         }
2255         else {
2256             $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2257         }
2258
2259         # Create the old_issues entry
2260         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2261
2262         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2263         if ( $privacy && $privacy == 2) {
2264             $old_checkout->borrowernumber($anonymouspatron)->store;
2265         }
2266
2267         # And finally delete the issue
2268         $issue->delete;
2269
2270         $issue->item->onloan(undef)->store({ log_action => 0 });
2271
2272         if ( C4::Context->preference('StoreLastBorrower') ) {
2273             my $item = Koha::Items->find( $itemnumber );
2274             $item->last_returned_by( $patron );
2275         }
2276
2277         # Remove any OVERDUES related debarment if the borrower has no overdues
2278         if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2279           && $patron->debarred
2280           && !$patron->has_overdues
2281           && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2282         ) {
2283             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2284         }
2285
2286     });
2287
2288     return $issue_id;
2289 }
2290
2291 =head2 _debar_user_on_return
2292
2293     _debar_user_on_return($borrower, $item, $datedue, $returndate);
2294
2295 C<$borrower> borrower hashref
2296
2297 C<$item> item hashref
2298
2299 C<$datedue> date due DateTime object
2300
2301 C<$returndate> DateTime object representing the return time
2302
2303 Internal function, called only by AddReturn that calculates and updates
2304  the user fine days, and debars them if necessary.
2305
2306 Should only be called for overdue returns
2307
2308 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2309 to ease testing.
2310
2311 =cut
2312
2313 sub _calculate_new_debar_dt {
2314     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2315
2316     my $branchcode = _GetCircControlBranch( $item, $borrower );
2317     my $circcontrol = C4::Context->preference('CircControl');
2318     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2319         {   categorycode => $borrower->{categorycode},
2320             itemtype     => $item->{itype},
2321             branchcode   => $branchcode,
2322             rules => [
2323                 'finedays',
2324                 'lengthunit',
2325                 'firstremind',
2326                 'maxsuspensiondays',
2327                 'suspension_chargeperiod',
2328             ]
2329         }
2330     );
2331     my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2332     my $unit     = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2333     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2334
2335     return unless $finedays;
2336
2337     # finedays is in days, so hourly loans must multiply by 24
2338     # thus 1 hour late equals 1 day suspension * finedays rate
2339     $finedays = $finedays * 24 if ( $unit eq 'hours' );
2340
2341     # grace period is measured in the same units as the loan
2342     my $grace =
2343       DateTime::Duration->new( $unit => $issuing_rule->{firstremind} );
2344
2345     my $deltadays = DateTime::Duration->new(
2346         days => $chargeable_units
2347     );
2348
2349     if ( $deltadays->subtract($grace)->is_positive() ) {
2350         my $suspension_days = $deltadays * $finedays;
2351
2352         if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2353             # No need to / 1 and do not consider / 0
2354             $suspension_days = DateTime::Duration->new(
2355                 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2356             );
2357         }
2358
2359         # If the max suspension days is < than the suspension days
2360         # the suspension days is limited to this maximum period.
2361         my $max_sd = $issuing_rule->{maxsuspensiondays};
2362         if ( defined $max_sd && $max_sd ne '' ) {
2363             $max_sd = DateTime::Duration->new( days => $max_sd );
2364             $suspension_days = $max_sd
2365               if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2366         }
2367
2368         my ( $has_been_extended );
2369         if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2370             my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2371             if ( $debarment ) {
2372                 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2373                 $has_been_extended = 1;
2374             }
2375         }
2376
2377         my $new_debar_dt;
2378         # Use the calendar or not to calculate the debarment date
2379         if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2380             my $calendar = Koha::Calendar->new(
2381                 branchcode => $branchcode,
2382                 days_mode  => 'Calendar'
2383             );
2384             $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2385         }
2386         else {
2387             $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2388         }
2389         return $new_debar_dt;
2390     }
2391     return;
2392 }
2393
2394 sub _debar_user_on_return {
2395     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2396
2397     $return_date //= dt_from_string();
2398
2399     my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2400
2401     return unless $new_debar_dt;
2402
2403     Koha::Patron::Debarments::AddUniqueDebarment({
2404         borrowernumber => $borrower->{borrowernumber},
2405         expiration     => $new_debar_dt->ymd(),
2406         type           => 'SUSPENSION',
2407     });
2408     # if borrower was already debarred but does not get an extra debarment
2409     my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2410     my ($new_debarment_str, $is_a_reminder);
2411     if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2412         $is_a_reminder = 1;
2413         $new_debarment_str = $borrower->{debarred};
2414     } else {
2415         $new_debarment_str = $new_debar_dt->ymd();
2416     }
2417     # FIXME Should return a DateTime object
2418     return $new_debarment_str, $is_a_reminder;
2419 }
2420
2421 =head2 _FixOverduesOnReturn
2422
2423    &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2424
2425 C<$borrowernumber> borrowernumber
2426
2427 C<$itemnumber> itemnumber
2428
2429 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2430
2431 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2432
2433 Internal function
2434
2435 =cut
2436
2437 sub _FixOverduesOnReturn {
2438     my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2439     unless( $borrowernumber ) {
2440         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2441         return;
2442     }
2443     unless( $item ) {
2444         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2445         return;
2446     }
2447     unless( $status ) {
2448         warn "_FixOverduesOnReturn() not supplied valid status";
2449         return;
2450     }
2451
2452     my $schema = Koha::Database->schema;
2453
2454     my $result = $schema->txn_do(
2455         sub {
2456             # check for overdue fine
2457             my $accountlines = Koha::Account::Lines->search(
2458                 {
2459                     borrowernumber  => $borrowernumber,
2460                     itemnumber      => $item,
2461                     debit_type_code => 'OVERDUE',
2462                     status          => 'UNRETURNED'
2463                 }
2464             );
2465             return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2466
2467             my $accountline = $accountlines->next;
2468             my $payments = $accountline->credits;
2469
2470             my $amountoutstanding = $accountline->amountoutstanding;
2471             if ( $accountline->amount == 0 && $payments->count == 0 ) {
2472                 $accountline->delete;
2473             } elsif ($exemptfine && ($amountoutstanding != 0)) {
2474                 my $account = Koha::Account->new({patron_id => $borrowernumber});
2475                 my $credit = $account->add_credit(
2476                     {
2477                         amount     => $amountoutstanding,
2478                         user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2479                         library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2480                         interface  => C4::Context->interface,
2481                         type       => 'FORGIVEN',
2482                         item_id    => $item
2483                     }
2484                 );
2485
2486                 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2487
2488                 if (C4::Context->preference("FinesLog")) {
2489                     &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2490                 }
2491
2492                 $accountline->status('FORGIVEN');
2493                 $accountline->store();
2494             } else {
2495                 $accountline->status($status);
2496                 $accountline->store();
2497
2498             }
2499         }
2500     );
2501
2502     return $result;
2503 }
2504
2505 =head2 _FixAccountForLostAndFound
2506
2507   &_FixAccountForLostAndFound($itemnumber, [$borrowernumber, $barcode]);
2508
2509 Finds the most recent lost item charge for this item and refunds the borrower
2510 appropriatly, taking into account any payments or writeoffs already applied
2511 against the charge.
2512
2513 Internal function, not exported, called only by AddReturn.
2514
2515 =cut
2516
2517 sub _FixAccountForLostAndFound {
2518     my $itemnumber     = shift or return;
2519     my $borrowernumber = @_ ? shift : undef;
2520     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
2521
2522     my $credit;
2523
2524     # check for charge made for lost book
2525     my $accountlines = Koha::Account::Lines->search(
2526         {
2527             itemnumber      => $itemnumber,
2528             debit_type_code => 'LOST',
2529             status          => [ undef, { '<>' => 'FOUND' } ]
2530         },
2531         {
2532             order_by => { -desc => [ 'date', 'accountlines_id' ] }
2533         }
2534     );
2535
2536     return unless $accountlines->count > 0;
2537     my $accountline     = $accountlines->next;
2538     my $total_to_refund = 0;
2539
2540     return unless $accountline->borrowernumber;
2541     my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2542     return unless $patron; # Patron has been deleted, nobody to credit the return to
2543
2544     my $account = $patron->account;
2545
2546     # Use cases
2547     if ( $accountline->amount > $accountline->amountoutstanding ) {
2548         # some amount has been cancelled. collect the offsets that are not writeoffs
2549         # this works because the only way to subtract from this kind of a debt is
2550         # using the UI buttons 'Pay' and 'Write off'
2551         my $credits_offsets = Koha::Account::Offsets->search({
2552             debit_id  => $accountline->id,
2553             credit_id => { '!=' => undef }, # it is not the debit itself
2554             type      => { '!=' => 'Writeoff' },
2555             amount    => { '<'  => 0 } # credits are negative on the DB
2556         });
2557
2558         $total_to_refund = ( $credits_offsets->count > 0 )
2559                             ? $credits_offsets->total * -1 # credits are negative on the DB
2560                             : 0;
2561     }
2562
2563     my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2564
2565     if ( $credit_total > 0 ) {
2566         my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2567         $credit = $account->add_credit(
2568             {
2569                 amount      => $credit_total,
2570                 description => 'Item found ' . $item_id,
2571                 type        => 'LOST_FOUND',
2572                 interface   => C4::Context->interface,
2573                 library_id  => $branchcode,
2574                 item_id     => $itemnumber
2575             }
2576         );
2577
2578         $credit->apply( { debits => [ $accountline ] } );
2579     }
2580
2581     # Update the account status
2582     $accountline->discard_changes->status('FOUND');
2583     $accountline->store;
2584
2585     $accountline->item->paidfor('')->store({ log_action => 0 });
2586
2587     if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2588         $account->reconcile_balance;
2589     }
2590
2591     return ($credit) ? $credit->id : undef;
2592 }
2593
2594 =head2 _GetCircControlBranch
2595
2596    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2597
2598 Internal function :
2599
2600 Return the library code to be used to determine which circulation
2601 policy applies to a transaction.  Looks up the CircControl and
2602 HomeOrHoldingBranch system preferences.
2603
2604 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2605
2606 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2607
2608 =cut
2609
2610 sub _GetCircControlBranch {
2611     my ($item, $borrower) = @_;
2612     my $circcontrol = C4::Context->preference('CircControl');
2613     my $branch;
2614
2615     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2616         $branch= C4::Context->userenv->{'branch'};
2617     } elsif ($circcontrol eq 'PatronLibrary') {
2618         $branch=$borrower->{branchcode};
2619     } else {
2620         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2621         $branch = $item->{$branchfield};
2622         # default to item home branch if holdingbranch is used
2623         # and is not defined
2624         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2625             $branch = $item->{homebranch};
2626         }
2627     }
2628     return $branch;
2629 }
2630
2631 =head2 GetOpenIssue
2632
2633   $issue = GetOpenIssue( $itemnumber );
2634
2635 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2636
2637 C<$itemnumber> is the item's itemnumber
2638
2639 Returns a hashref
2640
2641 =cut
2642
2643 sub GetOpenIssue {
2644   my ( $itemnumber ) = @_;
2645   return unless $itemnumber;
2646   my $dbh = C4::Context->dbh;
2647   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2648   $sth->execute( $itemnumber );
2649   return $sth->fetchrow_hashref();
2650
2651 }
2652
2653 =head2 GetBiblioIssues
2654
2655   $issues = GetBiblioIssues($biblionumber);
2656
2657 this function get all issues from a biblionumber.
2658
2659 Return:
2660 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2661 tables issues and the firstname,surname & cardnumber from borrowers.
2662
2663 =cut
2664
2665 sub GetBiblioIssues {
2666     my $biblionumber = shift;
2667     return unless $biblionumber;
2668     my $dbh   = C4::Context->dbh;
2669     my $query = "
2670         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2671         FROM issues
2672             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2673             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2674             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2675             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2676         WHERE biblio.biblionumber = ?
2677         UNION ALL
2678         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2679         FROM old_issues
2680             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2681             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2682             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2683             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2684         WHERE biblio.biblionumber = ?
2685         ORDER BY timestamp
2686     ";
2687     my $sth = $dbh->prepare($query);
2688     $sth->execute($biblionumber, $biblionumber);
2689
2690     my @issues;
2691     while ( my $data = $sth->fetchrow_hashref ) {
2692         push @issues, $data;
2693     }
2694     return \@issues;
2695 }
2696
2697 =head2 GetUpcomingDueIssues
2698
2699   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2700
2701 =cut
2702
2703 sub GetUpcomingDueIssues {
2704     my $params = shift;
2705
2706     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2707     my $dbh = C4::Context->dbh;
2708
2709     my $statement = <<END_SQL;
2710 SELECT *
2711 FROM (
2712     SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2713     FROM issues
2714     LEFT JOIN items USING (itemnumber)
2715     LEFT OUTER JOIN branches USING (branchcode)
2716     WHERE returndate is NULL
2717 ) tmp
2718 WHERE days_until_due >= 0 AND days_until_due <= ?
2719 END_SQL
2720
2721     my @bind_parameters = ( $params->{'days_in_advance'} );
2722
2723     my $sth = $dbh->prepare( $statement );
2724     $sth->execute( @bind_parameters );
2725     my $upcoming_dues = $sth->fetchall_arrayref({});
2726
2727     return $upcoming_dues;
2728 }
2729
2730 =head2 CanBookBeRenewed
2731
2732   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2733
2734 Find out whether a borrowed item may be renewed.
2735
2736 C<$borrowernumber> is the borrower number of the patron who currently
2737 has the item on loan.
2738
2739 C<$itemnumber> is the number of the item to renew.
2740
2741 C<$override_limit>, if supplied with a true value, causes
2742 the limit on the number of times that the loan can be renewed
2743 (as controlled by the item type) to be ignored. Overriding also allows
2744 to renew sooner than "No renewal before" and to manually renew loans
2745 that are automatically renewed.
2746
2747 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2748 item must currently be on loan to the specified borrower; renewals
2749 must be allowed for the item's type; and the borrower must not have
2750 already renewed the loan. $error will contain the reason the renewal can not proceed
2751
2752 =cut
2753
2754 sub CanBookBeRenewed {
2755     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2756
2757     my $dbh    = C4::Context->dbh;
2758     my $renews = 1;
2759     my $auto_renew = 0;
2760
2761     my $item      = Koha::Items->find($itemnumber)      or return ( 0, 'no_item' );
2762     my $issue = $item->checkout or return ( 0, 'no_checkout' );
2763     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2764     return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2765
2766     my $patron = $issue->patron or return;
2767
2768     # override_limit will override anything else except on_reserve
2769     unless ( $override_limit ){
2770         my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2771         my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2772             {
2773                 categorycode => $patron->categorycode,
2774                 itemtype     => $item->effective_itemtype,
2775                 branchcode   => $branchcode,
2776                 rules => [
2777                     'renewalsallowed',
2778                     'no_auto_renewal_after',
2779                     'no_auto_renewal_after_hard_limit',
2780                     'lengthunit',
2781                     'norenewalbefore',
2782                 ]
2783             }
2784         );
2785
2786         return ( 0, "too_many" )
2787           if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2788
2789         my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2790         my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2791         $patron         = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2792         my $restricted  = $patron->is_debarred;
2793         my $hasoverdues = $patron->has_overdues;
2794
2795         if ( $restricted and $restrictionblockrenewing ) {
2796             return ( 0, 'restriction');
2797         } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2798             return ( 0, 'overdue');
2799         }
2800
2801         if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2802
2803             if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2804                 return ( 0, 'auto_account_expired' );
2805             }
2806
2807             if ( defined $issuing_rule->{no_auto_renewal_after}
2808                     and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2809                 # Get issue_date and add no_auto_renewal_after
2810                 # If this is greater than today, it's too late for renewal.
2811                 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2812                 $maximum_renewal_date->add(
2813                     $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2814                 );
2815                 my $now = dt_from_string;
2816                 if ( $now >= $maximum_renewal_date ) {
2817                     return ( 0, "auto_too_late" );
2818                 }
2819             }
2820             if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2821                           and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2822                 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2823                 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2824                     return ( 0, "auto_too_late" );
2825                 }
2826             }
2827
2828             if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2829                 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2830                 my $amountoutstanding =
2831                   C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2832                   ? $patron->account->balance
2833                   : $patron->account->outstanding_debits->total_outstanding;
2834                 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2835                     return ( 0, "auto_too_much_oweing" );
2836                 }
2837             }
2838         }
2839
2840         if ( defined $issuing_rule->{norenewalbefore}
2841             and $issuing_rule->{norenewalbefore} ne "" )
2842         {
2843
2844             # Calculate soonest renewal by subtracting 'No renewal before' from due date
2845             my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2846                 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2847
2848             # Depending on syspref reset the exact time, only check the date
2849             if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2850                 and $issuing_rule->{lengthunit} eq 'days' )
2851             {
2852                 $soonestrenewal->truncate( to => 'day' );
2853             }
2854
2855             if ( $soonestrenewal > dt_from_string() )
2856             {
2857                 return ( 0, "auto_too_soon" ) if $issue->auto_renew && $patron->autorenew_checkouts;
2858                 return ( 0, "too_soon" );
2859             }
2860             elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2861                 $auto_renew = 1;
2862             }
2863         }
2864
2865         # Fallback for automatic renewals:
2866         # If norenewalbefore is undef, don't renew before due date.
2867         if ( $issue->auto_renew && !$auto_renew && $patron->autorenew_checkouts ) {
2868             my $now = dt_from_string;
2869             if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2870                 $auto_renew = 1;
2871             } else {
2872                 return ( 0, "auto_too_soon" );
2873             }
2874         }
2875     }
2876
2877     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2878
2879     # This item can fill one or more unfilled reserve, can those unfilled reserves
2880     # all be filled by other available items?
2881     if ( $resfound
2882         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2883     {
2884         my $schema = Koha::Database->new()->schema();
2885
2886         my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2887         if ($item_holds) {
2888             # There is an item level hold on this item, no other item can fill the hold
2889             $resfound = 1;
2890         }
2891         else {
2892
2893             # Get all other items that could possibly fill reserves
2894             my @itemnumbers = $schema->resultset('Item')->search(
2895                 {
2896                     biblionumber => $resrec->{biblionumber},
2897                     onloan       => undef,
2898                     notforloan   => 0,
2899                     -not         => { itemnumber => $itemnumber }
2900                 },
2901                 { columns => 'itemnumber' }
2902             )->get_column('itemnumber')->all();
2903
2904             # Get all other reserves that could have been filled by this item
2905             my @borrowernumbers;
2906             while (1) {
2907                 my ( $reserve_found, $reserve, undef ) =
2908                   C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2909
2910                 if ($reserve_found) {
2911                     push( @borrowernumbers, $reserve->{borrowernumber} );
2912                 }
2913                 else {
2914                     last;
2915                 }
2916             }
2917
2918             # If the count of the union of the lists of reservable items for each borrower
2919             # is equal or greater than the number of borrowers, we know that all reserves
2920             # can be filled with available items. We can get the union of the sets simply
2921             # by pushing all the elements onto an array and removing the duplicates.
2922             my @reservable;
2923             my %patrons;
2924             ITEM: foreach my $itemnumber (@itemnumbers) {
2925                 my $item = Koha::Items->find( $itemnumber );
2926                 next if IsItemOnHoldAndFound( $itemnumber );
2927                 for my $borrowernumber (@borrowernumbers) {
2928                     my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2929                     next unless IsAvailableForItemLevelRequest($item, $patron);
2930                     next unless CanItemBeReserved($borrowernumber,$itemnumber);
2931
2932                     push @reservable, $itemnumber;
2933                     if (@reservable >= @borrowernumbers) {
2934                         $resfound = 0;
2935                         last ITEM;
2936                     }
2937                     last;
2938                 }
2939             }
2940         }
2941     }
2942     return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2943     return ( 0, "auto_renew" ) if $auto_renew && !$override_limit; # 0 if auto-renewal should not succeed
2944
2945     return ( 1, undef );
2946 }
2947
2948 =head2 AddRenewal
2949
2950   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2951
2952 Renews a loan.
2953
2954 C<$borrowernumber> is the borrower number of the patron who currently
2955 has the item.
2956
2957 C<$itemnumber> is the number of the item to renew.
2958
2959 C<$branch> is the library where the renewal took place (if any).
2960            The library that controls the circ policies for the renewal is retrieved from the issues record.
2961
2962 C<$datedue> can be a DateTime object used to set the due date.
2963
2964 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2965 this parameter is not supplied, lastreneweddate is set to the current date.
2966
2967 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2968 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2969 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2970 syspref)
2971
2972 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2973 from the book's item type.
2974
2975 =cut
2976
2977 sub AddRenewal {
2978     my $borrowernumber  = shift;
2979     my $itemnumber      = shift or return;
2980     my $branch          = shift;
2981     my $datedue         = shift;
2982     my $lastreneweddate = shift || dt_from_string();
2983     my $skipfinecalc    = shift;
2984
2985     my $item_object   = Koha::Items->find($itemnumber) or return;
2986     my $biblio = $item_object->biblio;
2987     my $issue  = $item_object->checkout;
2988     my $item_unblessed = $item_object->unblessed;
2989
2990     my $dbh = C4::Context->dbh;
2991
2992     return unless $issue;
2993
2994     $borrowernumber ||= $issue->borrowernumber;
2995
2996     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2997         carp 'Invalid date passed to AddRenewal.';
2998         return;
2999     }
3000
3001     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3002     my $patron_unblessed = $patron->unblessed;
3003
3004     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3005
3006     my $schema = Koha::Database->schema;
3007     $schema->txn_do(sub{
3008
3009         if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3010             _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3011         }
3012         _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3013
3014         # If the due date wasn't specified, calculate it by adding the
3015         # book's loan length to today's date or the current due date
3016         # based on the value of the RenewalPeriodBase syspref.
3017         my $itemtype = $item_object->effective_itemtype;
3018         unless ($datedue) {
3019
3020             $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3021                                             dt_from_string( $issue->date_due, 'sql' ) :
3022                                             dt_from_string();
3023             $datedue =  CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3024         }
3025
3026         my $fees = Koha::Charges::Fees->new(
3027             {
3028                 patron    => $patron,
3029                 library   => $circ_library,
3030                 item      => $item_object,
3031                 from_date => dt_from_string( $issue->date_due, 'sql' ),
3032                 to_date   => dt_from_string($datedue),
3033             }
3034         );
3035
3036         # Update the issues record to have the new due date, and a new count
3037         # of how many times it has been renewed.
3038         my $renews = ( $issue->renewals || 0 ) + 1;
3039         my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
3040                                 WHERE borrowernumber=?
3041                                 AND itemnumber=?"
3042         );
3043
3044         $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
3045
3046         # Update the renewal count on the item, and tell zebra to reindex
3047         $renews = ( $item_object->renewals || 0 ) + 1;
3048         $item_object->renewals($renews);
3049         $item_object->onloan($datedue);
3050         $item_object->store({ log_action => 0 });
3051
3052         # Charge a new rental fee, if applicable
3053         my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3054         if ( $charge > 0 ) {
3055             AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3056         }
3057
3058         # Charge a new accumulate rental fee, if applicable
3059         my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3060         if ( $itemtype_object ) {
3061             my $accumulate_charge = $fees->accumulate_rentalcharge();
3062             if ( $accumulate_charge > 0 ) {
3063                 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3064             }
3065             $charge += $accumulate_charge;
3066         }
3067
3068         # Send a renewal slip according to checkout alert preferencei
3069         if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3070             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3071             my %conditions        = (
3072                 branchcode   => $branch,
3073                 categorycode => $patron->categorycode,
3074                 item_type    => $itemtype,
3075                 notification => 'CHECKOUT',
3076             );
3077             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3078                 SendCirculationAlert(
3079                     {
3080                         type     => 'RENEWAL',
3081                         item     => $item_unblessed,
3082                         borrower => $patron->unblessed,
3083                         branch   => $branch,
3084                     }
3085                 );
3086             }
3087         }
3088
3089         # Remove any OVERDUES related debarment if the borrower has no overdues
3090         if ( $patron
3091           && $patron->is_debarred
3092           && ! $patron->has_overdues
3093           && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3094         ) {
3095             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3096         }
3097
3098         # Add the renewal to stats
3099         UpdateStats(
3100             {
3101                 branch         => $item_object->renewal_branchcode({branch => $branch}),
3102                 type           => 'renew',
3103                 amount         => $charge,
3104                 itemnumber     => $itemnumber,
3105                 itemtype       => $itemtype,
3106                 location       => $item_object->location,
3107                 borrowernumber => $borrowernumber,
3108                 ccode          => $item_object->ccode,
3109             }
3110         );
3111
3112         #Log the renewal
3113         logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3114     });
3115
3116     return $datedue;
3117 }
3118
3119 sub GetRenewCount {
3120     # check renewal status
3121     my ( $bornum, $itemno ) = @_;
3122     my $dbh           = C4::Context->dbh;
3123     my $renewcount    = 0;
3124     my $renewsallowed = 0;
3125     my $renewsleft    = 0;
3126
3127     my $patron = Koha::Patrons->find( $bornum );
3128     my $item   = Koha::Items->find($itemno);
3129
3130     return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3131
3132     # Look in the issues table for this item, lent to this borrower,
3133     # and not yet returned.
3134
3135     # FIXME - I think this function could be redone to use only one SQL call.
3136     my $sth = $dbh->prepare(
3137         "select * from issues
3138                                 where (borrowernumber = ?)
3139                                 and (itemnumber = ?)"
3140     );
3141     $sth->execute( $bornum, $itemno );
3142     my $data = $sth->fetchrow_hashref;
3143     $renewcount = $data->{'renewals'} if $data->{'renewals'};
3144     # $item and $borrower should be calculated
3145     my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3146
3147     my $rule = Koha::CirculationRules->get_effective_rule(
3148         {
3149             categorycode => $patron->categorycode,
3150             itemtype     => $item->effective_itemtype,
3151             branchcode   => $branchcode,
3152             rule_name    => 'renewalsallowed',
3153         }
3154     );
3155
3156     $renewsallowed = $rule ? $rule->rule_value : 0;
3157     $renewsleft    = $renewsallowed - $renewcount;
3158     if($renewsleft < 0){ $renewsleft = 0; }
3159     return ( $renewcount, $renewsallowed, $renewsleft );
3160 }
3161
3162 =head2 GetSoonestRenewDate
3163
3164   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3165
3166 Find out the soonest possible renew date of a borrowed item.
3167
3168 C<$borrowernumber> is the borrower number of the patron who currently
3169 has the item on loan.
3170
3171 C<$itemnumber> is the number of the item to renew.
3172
3173 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3174 renew date, based on the value "No renewal before" of the applicable
3175 issuing rule. Returns the current date if the item can already be
3176 renewed, and returns undefined if the borrower, loan, or item
3177 cannot be found.
3178
3179 =cut
3180
3181 sub GetSoonestRenewDate {
3182     my ( $borrowernumber, $itemnumber ) = @_;
3183
3184     my $dbh = C4::Context->dbh;
3185
3186     my $item      = Koha::Items->find($itemnumber)      or return;
3187     my $itemissue = $item->checkout or return;
3188
3189     $borrowernumber ||= $itemissue->borrowernumber;
3190     my $patron = Koha::Patrons->find( $borrowernumber )
3191       or return;
3192
3193     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3194     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3195         {   categorycode => $patron->categorycode,
3196             itemtype     => $item->effective_itemtype,
3197             branchcode   => $branchcode,
3198             rules => [
3199                 'norenewalbefore',
3200                 'lengthunit',
3201             ]
3202         }
3203     );
3204
3205     my $now = dt_from_string;
3206     return $now unless $issuing_rule;
3207
3208     if ( defined $issuing_rule->{norenewalbefore}
3209         and $issuing_rule->{norenewalbefore} ne "" )
3210     {
3211         my $soonestrenewal =
3212           dt_from_string( $itemissue->date_due )->subtract(
3213             $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3214
3215         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3216             and $issuing_rule->{lengthunit} eq 'days' )
3217         {
3218             $soonestrenewal->truncate( to => 'day' );
3219         }
3220         return $soonestrenewal if $now < $soonestrenewal;
3221     }
3222     return $now;
3223 }
3224
3225 =head2 GetLatestAutoRenewDate
3226
3227   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3228
3229 Find out the latest possible auto renew date of a borrowed item.
3230
3231 C<$borrowernumber> is the borrower number of the patron who currently
3232 has the item on loan.
3233
3234 C<$itemnumber> is the number of the item to renew.
3235
3236 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3237 auto renew date, based on the value "No auto renewal after" and the "No auto
3238 renewal after (hard limit) of the applicable issuing rule.
3239 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3240 or item cannot be found.
3241
3242 =cut
3243
3244 sub GetLatestAutoRenewDate {
3245     my ( $borrowernumber, $itemnumber ) = @_;
3246
3247     my $dbh = C4::Context->dbh;
3248
3249     my $item      = Koha::Items->find($itemnumber)  or return;
3250     my $itemissue = $item->checkout                 or return;
3251
3252     $borrowernumber ||= $itemissue->borrowernumber;
3253     my $patron = Koha::Patrons->find( $borrowernumber )
3254       or return;
3255
3256     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3257     my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3258         {
3259             categorycode => $patron->categorycode,
3260             itemtype     => $item->effective_itemtype,
3261             branchcode   => $branchcode,
3262             rules => [
3263                 'no_auto_renewal_after',
3264                 'no_auto_renewal_after_hard_limit',
3265                 'lengthunit',
3266             ]
3267         }
3268     );
3269
3270     return unless $circulation_rules;
3271     return
3272       if ( not $circulation_rules->{no_auto_renewal_after}
3273             or $circulation_rules->{no_auto_renewal_after} eq '' )
3274       and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3275              or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3276
3277     my $maximum_renewal_date;
3278     if ( $circulation_rules->{no_auto_renewal_after} ) {
3279         $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3280         $maximum_renewal_date->add(
3281             $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3282         );
3283     }
3284
3285     if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3286         my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3287         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3288     }
3289     return $maximum_renewal_date;
3290 }
3291
3292
3293 =head2 GetIssuingCharges
3294
3295   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3296
3297 Calculate how much it would cost for a given patron to borrow a given
3298 item, including any applicable discounts.
3299
3300 C<$itemnumber> is the item number of item the patron wishes to borrow.
3301
3302 C<$borrowernumber> is the patron's borrower number.
3303
3304 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3305 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3306 if it's a video).
3307
3308 =cut
3309
3310 sub GetIssuingCharges {
3311
3312     # calculate charges due
3313     my ( $itemnumber, $borrowernumber ) = @_;
3314     my $charge = 0;
3315     my $dbh    = C4::Context->dbh;
3316     my $item_type;
3317
3318     # Get the book's item type and rental charge (via its biblioitem).
3319     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3320         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3321     $charge_query .= (C4::Context->preference('item-level_itypes'))
3322         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3323         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3324
3325     $charge_query .= ' WHERE items.itemnumber =?';
3326
3327     my $sth = $dbh->prepare($charge_query);
3328     $sth->execute($itemnumber);
3329     if ( my $item_data = $sth->fetchrow_hashref ) {
3330         $item_type = $item_data->{itemtype};
3331         $charge    = $item_data->{rentalcharge};
3332         my $branch = C4::Context::mybranch();
3333         my $patron = Koha::Patrons->find( $borrowernumber );
3334         my $discount = _get_discount_from_rule($patron->categorycode, $branch, $item_type);
3335         if ($discount) {
3336             # We may have multiple rules so get the most specific
3337             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3338         }
3339         if ($charge) {
3340             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3341         }
3342     }
3343
3344     return ( $charge, $item_type );
3345 }
3346
3347 # Select most appropriate discount rule from those returned
3348 sub _get_discount_from_rule {
3349     my ($categorycode, $branchcode, $itemtype) = @_;
3350
3351     # Set search precedences
3352     my @params = (
3353         {
3354             branchcode   => $branchcode,
3355             itemtype     => $itemtype,
3356             categorycode => $categorycode,
3357         },
3358         {
3359             branchcode   => undef,
3360             categorycode => $categorycode,
3361             itemtype     => $itemtype,
3362         },
3363         {
3364             branchcode   => $branchcode,
3365             categorycode => $categorycode,
3366             itemtype     => undef,
3367         },
3368         {
3369             branchcode   => undef,
3370             categorycode => $categorycode,
3371             itemtype     => undef,
3372         },
3373     );
3374
3375     foreach my $params (@params) {
3376         my $rule = Koha::CirculationRules->search(
3377             {
3378                 rule_name => 'rentaldiscount',
3379                 %$params,
3380             }
3381         )->next();
3382
3383         return $rule->rule_value if $rule;
3384     }
3385
3386     # none of the above
3387     return 0;
3388 }
3389
3390 =head2 AddIssuingCharge
3391
3392   &AddIssuingCharge( $checkout, $charge, $type )
3393
3394 =cut
3395
3396 sub AddIssuingCharge {
3397     my ( $checkout, $charge, $type ) = @_;
3398
3399     # FIXME What if checkout does not exist?
3400
3401     my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3402     my $accountline = $account->add_debit(
3403         {
3404             amount      => $charge,
3405             note        => undef,
3406             user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3407             library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3408             interface   => C4::Context->interface,
3409             type        => $type,
3410             item_id     => $checkout->itemnumber,
3411             issue_id    => $checkout->issue_id,
3412         }
3413     );
3414 }
3415
3416 =head2 GetTransfers
3417
3418   GetTransfers($itemnumber);
3419
3420 =cut
3421
3422 sub GetTransfers {
3423     my ($itemnumber) = @_;
3424
3425     my $dbh = C4::Context->dbh;
3426
3427     my $query = '
3428         SELECT datesent,
3429                frombranch,
3430                tobranch,
3431                branchtransfer_id
3432         FROM branchtransfers
3433         WHERE itemnumber = ?
3434           AND datearrived IS NULL
3435         ';
3436     my $sth = $dbh->prepare($query);
3437     $sth->execute($itemnumber);
3438     my @row = $sth->fetchrow_array();
3439     return @row;
3440 }
3441
3442 =head2 GetTransfersFromTo
3443
3444   @results = GetTransfersFromTo($frombranch,$tobranch);
3445
3446 Returns the list of pending transfers between $from and $to branch
3447
3448 =cut
3449
3450 sub GetTransfersFromTo {
3451     my ( $frombranch, $tobranch ) = @_;
3452     return unless ( $frombranch && $tobranch );
3453     my $dbh   = C4::Context->dbh;
3454     my $query = "
3455         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3456         FROM   branchtransfers
3457         WHERE  frombranch=?
3458           AND  tobranch=?
3459           AND datearrived IS NULL
3460     ";
3461     my $sth = $dbh->prepare($query);
3462     $sth->execute( $frombranch, $tobranch );
3463     my @gettransfers;
3464
3465     while ( my $data = $sth->fetchrow_hashref ) {
3466         push @gettransfers, $data;
3467     }
3468     return (@gettransfers);
3469 }
3470
3471 =head2 DeleteTransfer
3472
3473   &DeleteTransfer($itemnumber);
3474
3475 =cut
3476
3477 sub DeleteTransfer {
3478     my ($itemnumber) = @_;
3479     return unless $itemnumber;
3480     my $dbh          = C4::Context->dbh;
3481     my $sth          = $dbh->prepare(
3482         "DELETE FROM branchtransfers
3483          WHERE itemnumber=?
3484          AND datearrived IS NULL "
3485     );
3486     return $sth->execute($itemnumber);
3487 }
3488
3489 =head2 SendCirculationAlert
3490
3491 Send out a C<check-in> or C<checkout> alert using the messaging system.
3492
3493 B<Parameters>:
3494
3495 =over 4
3496
3497 =item type
3498
3499 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3500
3501 =item item
3502
3503 Hashref of information about the item being checked in or out.
3504
3505 =item borrower
3506
3507 Hashref of information about the borrower of the item.
3508
3509 =item branch
3510
3511 The branchcode from where the checkout or check-in took place.
3512
3513 =back
3514
3515 B<Example>:
3516
3517     SendCirculationAlert({
3518         type     => 'CHECKOUT',
3519         item     => $item,
3520         borrower => $borrower,
3521         branch   => $branch,
3522     });
3523
3524 =cut
3525
3526 sub SendCirculationAlert {
3527     my ($opts) = @_;
3528     my ($type, $item, $borrower, $branch) =
3529         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3530     my %message_name = (
3531         CHECKIN  => 'Item_Check_in',
3532         CHECKOUT => 'Item_Checkout',
3533         RENEWAL  => 'Item_Checkout',
3534     );
3535     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3536         borrowernumber => $borrower->{borrowernumber},
3537         message_name   => $message_name{$type},
3538     });
3539     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3540
3541     my $schema = Koha::Database->new->schema;
3542     my @transports = keys %{ $borrower_preferences->{transports} };
3543
3544     # From the MySQL doc:
3545     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3546     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3547     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3548     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3549
3550     for my $mtt (@transports) {
3551         my $letter =  C4::Letters::GetPreparedLetter (
3552             module => 'circulation',
3553             letter_code => $type,
3554             branchcode => $branch,
3555             message_transport_type => $mtt,
3556             lang => $borrower->{lang},
3557             tables => {
3558                 $issues_table => $item->{itemnumber},
3559                 'items'       => $item->{itemnumber},
3560                 'biblio'      => $item->{biblionumber},
3561                 'biblioitems' => $item->{biblionumber},
3562                 'borrowers'   => $borrower,
3563                 'branches'    => $branch,
3564             }
3565         ) or next;
3566
3567         $schema->storage->txn_begin;
3568         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3569         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3570         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3571         unless ( $message ) {
3572             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3573             C4::Message->enqueue($letter, $borrower, $mtt);
3574         } else {
3575             $message->append($letter);
3576             $message->update;
3577         }
3578         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3579         $schema->storage->txn_commit;
3580     }
3581
3582     return;
3583 }
3584
3585 =head2 updateWrongTransfer
3586
3587   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3588
3589 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
3590
3591 =cut
3592
3593 sub updateWrongTransfer {
3594         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3595         my $dbh = C4::Context->dbh;
3596 # first step validate the actual line of transfert .
3597         my $sth =
3598                 $dbh->prepare(
3599                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3600                 );
3601                 $sth->execute($FromLibrary,$itemNumber);
3602
3603 # second step create a new line of branchtransfer to the right location .
3604         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3605
3606 #third step changing holdingbranch of item
3607     my $item = Koha::Items->find($itemNumber)->holdingbranch($FromLibrary)->store;
3608 }
3609
3610 =head2 CalcDateDue
3611
3612 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3613
3614 this function calculates the due date given the start date and configured circulation rules,
3615 checking against the holidays calendar as per the daysmode circulation rule.
3616 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3617 C<$itemtype>  = itemtype code of item in question
3618 C<$branch>  = location whose calendar to use
3619 C<$borrower> = Borrower object
3620 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3621
3622 =cut
3623
3624 sub CalcDateDue {
3625     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3626
3627     $isrenewal ||= 0;
3628
3629     # loanlength now a href
3630     my $loanlength =
3631             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3632
3633     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3634             ? qq{renewalperiod}
3635             : qq{issuelength};
3636
3637     my $datedue;
3638     if ( $startdate ) {
3639         if (ref $startdate ne 'DateTime' ) {
3640             $datedue = dt_from_string($datedue);
3641         } else {
3642             $datedue = $startdate->clone;
3643         }
3644     } else {
3645         $datedue = dt_from_string()->truncate( to => 'minute' );
3646     }
3647
3648
3649     my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3650         {
3651             categorycode => $borrower->{categorycode},
3652             itemtype     => $itemtype,
3653             branchcode   => $branch,
3654         }
3655     );
3656
3657     # calculate the datedue as normal
3658     if ( $daysmode eq 'Days' )
3659     {    # ignoring calendar
3660         if ( $loanlength->{lengthunit} eq 'hours' ) {
3661             $datedue->add( hours => $loanlength->{$length_key} );
3662         } else {    # days
3663             $datedue->add( days => $loanlength->{$length_key} );
3664             $datedue->set_hour(23);
3665             $datedue->set_minute(59);
3666         }
3667     } else {
3668         my $dur;
3669         if ($loanlength->{lengthunit} eq 'hours') {
3670             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3671         }
3672         else { # days
3673             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3674         }
3675         my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3676         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3677         if ($loanlength->{lengthunit} eq 'days') {
3678             $datedue->set_hour(23);
3679             $datedue->set_minute(59);
3680         }
3681     }
3682
3683     # if Hard Due Dates are used, retrieve them and apply as necessary
3684     my ( $hardduedate, $hardduedatecompare ) =
3685       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3686     if ($hardduedate) {    # hardduedates are currently dates
3687         $hardduedate->truncate( to => 'minute' );
3688         $hardduedate->set_hour(23);
3689         $hardduedate->set_minute(59);
3690         my $cmp = DateTime->compare( $hardduedate, $datedue );
3691
3692 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3693 # if the calculated date is before the 'after' Hard Due Date (floor), override
3694 # if the hard due date is set to 'exactly', overrride
3695         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3696             $datedue = $hardduedate->clone;
3697         }
3698
3699         # in all other cases, keep the date due as it is
3700
3701     }
3702
3703     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3704     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3705         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3706         if( $expiry_dt ) { #skip empty expiry date..
3707             $expiry_dt->set( hour => 23, minute => 59);
3708             my $d1= $datedue->clone->set_time_zone('floating');
3709             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3710                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3711             }
3712         }
3713         if ( $daysmode ne 'Days' ) {
3714           my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3715           if ( $calendar->is_holiday($datedue) ) {
3716               # Don't return on a closed day
3717               $datedue = $calendar->prev_open_days( $datedue, 1 );
3718           }
3719         }
3720     }
3721
3722     return $datedue;
3723 }
3724
3725
3726 sub CheckValidBarcode{
3727 my ($barcode) = @_;
3728 my $dbh = C4::Context->dbh;
3729 my $query=qq|SELECT count(*)
3730              FROM items
3731              WHERE barcode=?
3732             |;
3733 my $sth = $dbh->prepare($query);
3734 $sth->execute($barcode);
3735 my $exist=$sth->fetchrow ;
3736 return $exist;
3737 }
3738
3739 =head2 IsBranchTransferAllowed
3740
3741   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3742
3743 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3744
3745 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3746 Koha::Item->can_be_transferred.
3747
3748 =cut
3749
3750 sub IsBranchTransferAllowed {
3751         my ( $toBranch, $fromBranch, $code ) = @_;
3752
3753         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3754
3755         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3756         my $dbh = C4::Context->dbh;
3757
3758         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3759         $sth->execute( $toBranch, $fromBranch, $code );
3760         my $limit = $sth->fetchrow_hashref();
3761
3762         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3763         if ( $limit->{'limitId'} ) {
3764                 return 0;
3765         } else {
3766                 return 1;
3767         }
3768 }
3769
3770 =head2 CreateBranchTransferLimit
3771
3772   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3773
3774 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3775
3776 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3777
3778 =cut
3779
3780 sub CreateBranchTransferLimit {
3781    my ( $toBranch, $fromBranch, $code ) = @_;
3782    return unless defined($toBranch) && defined($fromBranch);
3783    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3784
3785    my $dbh = C4::Context->dbh;
3786
3787    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3788    return $sth->execute( $code, $toBranch, $fromBranch );
3789 }
3790
3791 =head2 DeleteBranchTransferLimits
3792
3793     my $result = DeleteBranchTransferLimits($frombranch);
3794
3795 Deletes all the library transfer limits for one library.  Returns the
3796 number of limits deleted, 0e0 if no limits were deleted, or undef if
3797 no arguments are supplied.
3798
3799 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3800     fromBranch => $fromBranch
3801     })->delete.
3802
3803 =cut
3804
3805 sub DeleteBranchTransferLimits {
3806     my $branch = shift;
3807     return unless defined $branch;
3808     my $dbh    = C4::Context->dbh;
3809     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3810     return $sth->execute($branch);
3811 }
3812
3813 sub ReturnLostItem{
3814     my ( $borrowernumber, $itemnum ) = @_;
3815     MarkIssueReturned( $borrowernumber, $itemnum );
3816 }
3817
3818
3819 sub LostItem{
3820     my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3821
3822     unless ( $mark_lost_from ) {
3823         # Temporary check to avoid regressions
3824         die q|LostItem called without $mark_lost_from, check the API.|;
3825     }
3826
3827     my $mark_returned;
3828     if ( $force_mark_returned ) {
3829         $mark_returned = 1;
3830     } else {
3831         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3832         $mark_returned = ( $pref =~ m|$mark_lost_from| );
3833     }
3834
3835     my $dbh = C4::Context->dbh();
3836     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3837                            FROM issues
3838                            JOIN items USING (itemnumber)
3839                            JOIN biblio USING (biblionumber)
3840                            WHERE issues.itemnumber=?");
3841     $sth->execute($itemnumber);
3842     my $issues=$sth->fetchrow_hashref();
3843
3844     # If a borrower lost the item, add a replacement cost to the their record
3845     if ( my $borrowernumber = $issues->{borrowernumber} ){
3846         my $patron = Koha::Patrons->find( $borrowernumber );
3847
3848         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3849         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3850
3851         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3852             C4::Accounts::chargelostitem(
3853                 $borrowernumber,
3854                 $itemnumber,
3855                 $issues->{'replacementprice'},
3856                 sprintf( "%s %s %s",
3857                     $issues->{'title'}          || q{},
3858                     $issues->{'barcode'}        || q{},
3859                     $issues->{'itemcallnumber'} || q{},
3860                 ),
3861             );
3862             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3863             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3864         }
3865
3866         MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3867     }
3868
3869     #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3870     if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3871         Koha::Items->find($itemnumber)->holdingbranch($frombranch)->store;
3872     }
3873     my $transferdeleted = DeleteTransfer($itemnumber);
3874 }
3875
3876 sub GetOfflineOperations {
3877     my $dbh = C4::Context->dbh;
3878     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3879     $sth->execute(C4::Context->userenv->{'branch'});
3880     my $results = $sth->fetchall_arrayref({});
3881     return $results;
3882 }
3883
3884 sub GetOfflineOperation {
3885     my $operationid = shift;
3886     return unless $operationid;
3887     my $dbh = C4::Context->dbh;
3888     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3889     $sth->execute( $operationid );
3890     return $sth->fetchrow_hashref;
3891 }
3892
3893 sub AddOfflineOperation {
3894     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3895     my $dbh = C4::Context->dbh;
3896     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3897     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3898     return "Added.";
3899 }
3900
3901 sub DeleteOfflineOperation {
3902     my $dbh = C4::Context->dbh;
3903     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3904     $sth->execute( shift );
3905     return "Deleted.";
3906 }
3907
3908 sub ProcessOfflineOperation {
3909     my $operation = shift;
3910
3911     my $report;
3912     if ( $operation->{action} eq 'return' ) {
3913         $report = ProcessOfflineReturn( $operation );
3914     } elsif ( $operation->{action} eq 'issue' ) {
3915         $report = ProcessOfflineIssue( $operation );
3916     } elsif ( $operation->{action} eq 'payment' ) {
3917         $report = ProcessOfflinePayment( $operation );
3918     }
3919
3920     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3921
3922     return $report;
3923 }
3924
3925 sub ProcessOfflineReturn {
3926     my $operation = shift;
3927
3928     my $item = Koha::Items->find({barcode => $operation->{barcode}});
3929
3930     if ( $item ) {
3931         my $itemnumber = $item->itemnumber;
3932         my $issue = GetOpenIssue( $itemnumber );
3933         if ( $issue ) {
3934             my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3935             ModDateLastSeen( $itemnumber, $leave_item_lost );
3936             MarkIssueReturned(
3937                 $issue->{borrowernumber},
3938                 $itemnumber,
3939                 $operation->{timestamp},
3940             );
3941             $item->renewals(0);
3942             $item->onloan(undef);
3943             $item->store({ log_action => 0 });
3944             return "Success.";
3945         } else {
3946             return "Item not issued.";
3947         }
3948     } else {
3949         return "Item not found.";
3950     }
3951 }
3952
3953 sub ProcessOfflineIssue {
3954     my $operation = shift;
3955
3956     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3957
3958     if ( $patron ) {
3959         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3960         unless ($item) {
3961             return "Barcode not found.";
3962         }
3963         my $itemnumber = $item->itemnumber;
3964         my $issue = GetOpenIssue( $itemnumber );
3965
3966         if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3967             MarkIssueReturned(
3968                 $issue->{borrowernumber},
3969                 $itemnumber,
3970                 $operation->{timestamp},
3971             );
3972         }
3973         AddIssue(
3974             $patron->unblessed,
3975             $operation->{'barcode'},
3976             undef,
3977             1,
3978             $operation->{timestamp},
3979             undef,
3980         );
3981         return "Success.";
3982     } else {
3983         return "Borrower not found.";
3984     }
3985 }
3986
3987 sub ProcessOfflinePayment {
3988     my $operation = shift;
3989
3990     my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3991
3992     $patron->account->pay(
3993         {
3994             amount     => $operation->{amount},
3995             library_id => $operation->{branchcode},
3996             interface  => 'koc'
3997         }
3998     );
3999
4000     return "Success.";
4001 }
4002
4003 =head2 TransferSlip
4004
4005   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4006
4007   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4008
4009 =cut
4010
4011 sub TransferSlip {
4012     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4013
4014     my $item =
4015       $itemnumber
4016       ? Koha::Items->find($itemnumber)
4017       : Koha::Items->find( { barcode => $barcode } );
4018
4019     $item or return;
4020
4021     return C4::Letters::GetPreparedLetter (
4022         module => 'circulation',
4023         letter_code => 'TRANSFERSLIP',
4024         branchcode => $branch,
4025         tables => {
4026             'branches'    => $to_branch,
4027             'biblio'      => $item->biblionumber,
4028             'items'       => $item->unblessed,
4029         },
4030     );
4031 }
4032
4033 =head2 CheckIfIssuedToPatron
4034
4035   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4036
4037   Return 1 if any record item is issued to patron, otherwise return 0
4038
4039 =cut
4040
4041 sub CheckIfIssuedToPatron {
4042     my ($borrowernumber, $biblionumber) = @_;
4043
4044     my $dbh = C4::Context->dbh;
4045     my $query = q|
4046         SELECT COUNT(*) FROM issues
4047         LEFT JOIN items ON items.itemnumber = issues.itemnumber
4048         WHERE items.biblionumber = ?
4049         AND issues.borrowernumber = ?
4050     |;
4051     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4052     return 1 if $is_issued;
4053     return;
4054 }
4055
4056 =head2 IsItemIssued
4057
4058   IsItemIssued( $itemnumber )
4059
4060   Return 1 if the item is on loan, otherwise return 0
4061
4062 =cut
4063
4064 sub IsItemIssued {
4065     my $itemnumber = shift;
4066     my $dbh = C4::Context->dbh;
4067     my $sth = $dbh->prepare(q{
4068         SELECT COUNT(*)
4069         FROM issues
4070         WHERE itemnumber = ?
4071     });
4072     $sth->execute($itemnumber);
4073     return $sth->fetchrow;
4074 }
4075
4076 =head2 GetAgeRestriction
4077
4078   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4079   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4080
4081   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4082   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4083
4084 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4085 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4086 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4087          Negative days mean the borrower has gone past the age restriction age.
4088
4089 =cut
4090
4091 sub GetAgeRestriction {
4092     my ($record_restrictions, $borrower) = @_;
4093     my $markers = C4::Context->preference('AgeRestrictionMarker');
4094
4095     return unless $record_restrictions;
4096     # Split $record_restrictions to something like FSK 16 or PEGI 6
4097     my @values = split ' ', uc($record_restrictions);
4098     return unless @values;
4099
4100     # Search first occurrence of one of the markers
4101     my @markers = split /\|/, uc($markers);
4102     return unless @markers;
4103
4104     my $index            = 0;
4105     my $restriction_year = 0;
4106     for my $value (@values) {
4107         $index++;
4108         for my $marker (@markers) {
4109             $marker =~ s/^\s+//;    #remove leading spaces
4110             $marker =~ s/\s+$//;    #remove trailing spaces
4111             if ( $marker eq $value ) {
4112                 if ( $index <= $#values ) {
4113                     $restriction_year += $values[$index];
4114                 }
4115                 last;
4116             }
4117             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4118
4119                 # Perhaps it is something like "K16" (as in Finland)
4120                 $restriction_year += $1;
4121                 last;
4122             }
4123         }
4124         last if ( $restriction_year > 0 );
4125     }
4126
4127     #Check if the borrower is age restricted for this material and for how long.
4128     if ($restriction_year && $borrower) {
4129         if ( $borrower->{'dateofbirth'} ) {
4130             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4131             $alloweddate[0] += $restriction_year;
4132
4133             #Prevent runime eror on leap year (invalid date)
4134             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4135                 $alloweddate[2] = 28;
4136             }
4137
4138             #Get how many days the borrower has to reach the age restriction
4139             my @Today = split /-/, dt_from_string()->ymd();
4140             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4141             #Negative days means the borrower went past the age restriction age
4142             return ($restriction_year, $daysToAgeRestriction);
4143         }
4144     }
4145
4146     return ($restriction_year);
4147 }
4148
4149
4150 =head2 GetPendingOnSiteCheckouts
4151
4152 =cut
4153
4154 sub GetPendingOnSiteCheckouts {
4155     my $dbh = C4::Context->dbh;
4156     return $dbh->selectall_arrayref(q|
4157         SELECT
4158           items.barcode,
4159           items.biblionumber,
4160           items.itemnumber,
4161           items.itemnotes,
4162           items.itemcallnumber,
4163           items.location,
4164           issues.date_due,
4165           issues.branchcode,
4166           issues.date_due < NOW() AS is_overdue,
4167           biblio.author,
4168           biblio.title,
4169           borrowers.firstname,
4170           borrowers.surname,
4171           borrowers.cardnumber,
4172           borrowers.borrowernumber
4173         FROM items
4174         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4175         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4176         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4177         WHERE issues.onsite_checkout = 1
4178     |, { Slice => {} } );
4179 }
4180
4181 sub GetTopIssues {
4182     my ($params) = @_;
4183
4184     my ($count, $branch, $itemtype, $ccode, $newness)
4185         = @$params{qw(count branch itemtype ccode newness)};
4186
4187     my $dbh = C4::Context->dbh;
4188     my $query = q{
4189         SELECT * FROM (
4190         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4191           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4192           i.ccode, SUM(i.issues) AS count
4193         FROM biblio b
4194         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4195         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4196     };
4197
4198     my (@where_strs, @where_args);
4199
4200     if ($branch) {
4201         push @where_strs, 'i.homebranch = ?';
4202         push @where_args, $branch;
4203     }
4204     if ($itemtype) {
4205         if (C4::Context->preference('item-level_itypes')){
4206             push @where_strs, 'i.itype = ?';
4207             push @where_args, $itemtype;
4208         } else {
4209             push @where_strs, 'bi.itemtype = ?';
4210             push @where_args, $itemtype;
4211         }
4212     }
4213     if ($ccode) {
4214         push @where_strs, 'i.ccode = ?';
4215         push @where_args, $ccode;
4216     }
4217     if ($newness) {
4218         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4219         push @where_args, $newness;
4220     }
4221
4222     if (@where_strs) {
4223         $query .= 'WHERE ' . join(' AND ', @where_strs);
4224     }
4225
4226     $query .= q{
4227         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4228           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4229           i.ccode
4230         ORDER BY count DESC
4231     };
4232
4233     $query .= q{ ) xxx WHERE count > 0 };
4234     $count = int($count);
4235     if ($count > 0) {
4236         $query .= "LIMIT $count";
4237     }
4238
4239     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4240
4241     return @$rows;
4242 }
4243
4244 sub _CalculateAndUpdateFine {
4245     my ($params) = @_;
4246
4247     my $borrower    = $params->{borrower};
4248     my $item        = $params->{item};
4249     my $issue       = $params->{issue};
4250     my $return_date = $params->{return_date};
4251
4252     unless ($borrower) { carp "No borrower passed in!" && return; }
4253     unless ($item)     { carp "No item passed in!"     && return; }
4254     unless ($issue)    { carp "No issue passed in!"    && return; }
4255
4256     my $datedue = dt_from_string( $issue->date_due );
4257
4258     # we only need to calculate and change the fines if we want to do that on return
4259     # Should be on for hourly loans
4260     my $control = C4::Context->preference('CircControl');
4261     my $control_branchcode =
4262         ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4263       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4264       :                                     $issue->branchcode;
4265
4266     my $date_returned = $return_date ? $return_date : dt_from_string();
4267
4268     my ( $amount, $unitcounttotal, $unitcount  ) =
4269       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4270
4271     if ( C4::Context->preference('finesMode') eq 'production' ) {
4272         if ( $amount > 0 ) {
4273             C4::Overdues::UpdateFine({
4274                 issue_id       => $issue->issue_id,
4275                 itemnumber     => $issue->itemnumber,
4276                 borrowernumber => $issue->borrowernumber,
4277                 amount         => $amount,
4278                 due            => output_pref($datedue),
4279             });
4280         }
4281         elsif ($return_date) {
4282
4283             # Backdated returns may have fines that shouldn't exist,
4284             # so in this case, we need to drop those fines to 0
4285
4286             C4::Overdues::UpdateFine({
4287                 issue_id       => $issue->issue_id,
4288                 itemnumber     => $issue->itemnumber,
4289                 borrowernumber => $issue->borrowernumber,
4290                 amount         => 0,
4291                 due            => output_pref($datedue),
4292             });
4293         }
4294     }
4295 }
4296
4297 sub _item_denied_renewal {
4298     my ($params) = @_;
4299
4300     my $item = $params->{item};
4301     return unless $item;
4302
4303     my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4304     return unless $denyingrules;
4305     foreach my $field (keys %$denyingrules) {
4306         my $val = $item->$field;
4307         if( !defined $val) {
4308             if ( any { !defined $_ }  @{$denyingrules->{$field}} ){
4309                 return 1;
4310             }
4311         } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4312            # If the results matches the values in the syspref
4313            # We return true if match found
4314             return 1;
4315         }
4316     }
4317     return 0;
4318 }
4319
4320
4321 1;
4322
4323 __END__
4324
4325 =head1 AUTHOR
4326
4327 Koha Development Team <http://koha-community.org/>
4328
4329 =cut