C4/Circulation.pm

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