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