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