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