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