C4/Circulation.pm

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