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