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