C4/Circulation.pm

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