C4/Circulation.pm

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