C4/Circulation.pm

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