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