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