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