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  = Koha::Checkouts->find( { itemnumber => $itemnumber } );
1837     if ( $issue ) {
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->unblessed) . "\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 $is_overdue;
1923         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1924         $borrower or warn "AddReturn without current borrower";
1925                 my $circControlBranch;
1926         if ($dropbox) {
1927             # define circControlBranch only if dropbox mode is set
1928             # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1929             # FIXME: check issuedate > returndate, factoring in holidays
1930
1931             $circControlBranch = _GetCircControlBranch($item,$borrower);
1932             $is_overdue = $issue->is_overdue( $dropboxdate );
1933         } else {
1934             $is_overdue = $issue->is_overdue;
1935         }
1936
1937         if ($borrowernumber) {
1938             eval {
1939                 my $issue_id = MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1940                     $circControlBranch, $return_date, $borrower->{'privacy'} );
1941                 $issue->{issue_id} = $issue_id;
1942             };
1943             unless ( $@ ) {
1944                 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $is_overdue ) || $return_date ) {
1945                     _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $borrower, return_date => $return_date } );
1946                 }
1947             } else {
1948                 $messages->{'Wrongbranch'} = {
1949                     Wrongbranch => $branch,
1950                     Rightbranch => $message
1951                 };
1952                 carp $@;
1953                 return ( 0, { WasReturned => 0 }, $issue, $borrower );
1954             }
1955
1956             # FIXME is the "= 1" right?  This could be the borrower hash.
1957             $messages->{'WasReturned'} = 1;
1958
1959         }
1960
1961         ModItem({ onloan => undef }, $item->{biblionumber}, $item->{'itemnumber'});
1962     }
1963
1964     # the holdingbranch is updated if the document is returned to another location.
1965     # this is always done regardless of whether the item was on loan or not
1966     my $item_holding_branch = $item->{ holdingbranch };
1967     if ($item->{'holdingbranch'} ne $branch) {
1968         UpdateHoldingbranch($branch, $item->{'itemnumber'});
1969         $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1970     }
1971     ModDateLastSeen( $item->{'itemnumber'} );
1972
1973     # check if we have a transfer for this document
1974     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1975
1976     # if we have a transfer to do, we update the line of transfers with the datearrived
1977     my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->{'itemnumber'} );
1978     if ($datesent) {
1979         if ( $tobranch eq $branch ) {
1980             my $sth = C4::Context->dbh->prepare(
1981                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1982             );
1983             $sth->execute( $item->{'itemnumber'} );
1984             # if we have a reservation with valid transfer, we can set it's status to 'W'
1985             ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1986             C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1987         } else {
1988             $messages->{'WrongTransfer'}     = $tobranch;
1989             $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1990         }
1991         $validTransfert = 1;
1992     } else {
1993         ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1994     }
1995
1996     # fix up the accounts.....
1997     if ( $item->{'itemlost'} ) {
1998         $messages->{'WasLost'} = 1;
1999
2000         if ( $item->{'itemlost'} ) {
2001             if (
2002                 Koha::RefundLostItemFeeRules->should_refund(
2003                     {
2004                         current_branch      => C4::Context->userenv->{branch},
2005                         item_home_branch    => $item->{homebranch},
2006                         item_holding_branch => $item_holding_branch
2007                     }
2008                 )
2009               )
2010             {
2011                 _FixAccountForLostAndReturned( $item->{'itemnumber'}, $borrowernumber, $barcode );
2012                 $messages->{'LostItemFeeRefunded'} = 1;
2013             }
2014         }
2015     }
2016
2017     # fix up the overdues in accounts...
2018     if ($borrowernumber) {
2019         my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
2020         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!";  # zero is OK, check defined
2021
2022         if ( $issue and $issue->is_overdue ) {
2023         # fix fine days
2024             $today = $dropboxdate if $dropbox;
2025             my ($debardate,$reminder) = _debar_user_on_return( $borrower, $item, dt_from_string($issue->date_due), $today );
2026             if ($reminder){
2027                 $messages->{'PrevDebarred'} = $debardate;
2028             } else {
2029                 $messages->{'Debarred'} = $debardate if $debardate;
2030             }
2031         # there's no overdue on the item but borrower had been previously debarred
2032         } elsif ( $issue->date_due and $borrower->{'debarred'} ) {
2033              if ( $borrower->{debarred} eq "9999-12-31") {
2034                 $messages->{'ForeverDebarred'} = $borrower->{'debarred'};
2035              } else {
2036                   my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
2037                   $borrower_debar_dt->truncate(to => 'day');
2038                   my $today_dt = $today->clone()->truncate(to => 'day');
2039                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2040                       $messages->{'PrevDebarred'} = $borrower->{'debarred'};
2041                   }
2042              }
2043         }
2044     }
2045
2046     # find reserves.....
2047     # if we don't have a reserve with the status W, we launch the Checkreserves routine
2048     my ($resfound, $resrec);
2049     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2050     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
2051     if ($resfound) {
2052           $resrec->{'ResFound'} = $resfound;
2053         $messages->{'ResFound'} = $resrec;
2054     }
2055
2056     # Record the fact that this book was returned.
2057     UpdateStats({
2058         branch         => $branch,
2059         type           => $stat_type,
2060         itemnumber     => $itemnumber,
2061         itemtype       => $itemtype,
2062         borrowernumber => $borrowernumber,
2063         ccode          => $item->{ ccode }
2064     });
2065
2066     # Send a check-in slip. # NOTE: borrower may be undef.  probably shouldn't try to send messages then.
2067     my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2068     my %conditions = (
2069         branchcode   => $branch,
2070         categorycode => $borrower->{categorycode},
2071         item_type    => $item->{itype},
2072         notification => 'CHECKIN',
2073     );
2074     if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2075         SendCirculationAlert({
2076             type     => 'CHECKIN',
2077             item     => $item,
2078             borrower => $borrower,
2079             branch   => $branch,
2080         });
2081     }
2082
2083     logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2084         if C4::Context->preference("ReturnLog");
2085
2086     # Remove any OVERDUES related debarment if the borrower has no overdues
2087     if ( $borrowernumber
2088       && $borrower->{'debarred'}
2089       && C4::Context->preference('AutoRemoveOverduesRestrictions')
2090       && !Koha::Patrons->find( $borrowernumber )->has_overdues
2091       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2092     ) {
2093         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2094     }
2095
2096     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2097     if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2098         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2099             (C4::Context->preference("UseBranchTransferLimits") and
2100              ! IsBranchTransferAllowed($branch, $returnbranch, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2101            )) {
2102             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $returnbranch;
2103             $debug and warn "item: " . Dumper($item);
2104             ModItemTransfer($item->{'itemnumber'}, $branch, $returnbranch);
2105             $messages->{'WasTransfered'} = 1;
2106         } else {
2107             $messages->{'NeedsTransfer'} = $returnbranch;
2108         }
2109     }
2110
2111     return ( $doreturn, $messages, $issue, $borrower );
2112 }
2113
2114 =head2 MarkIssueReturned
2115
2116   MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2117
2118 Unconditionally marks an issue as being returned by
2119 moving the C<issues> row to C<old_issues> and
2120 setting C<returndate> to the current date, or
2121 the last non-holiday date of the branccode specified in
2122 C<dropbox_branch> .  Assumes you've already checked that
2123 it's safe to do this, i.e. last non-holiday > issuedate.
2124
2125 if C<$returndate> is specified (in iso format), it is used as the date
2126 of the return. It is ignored when a dropbox_branch is passed in.
2127
2128 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2129 the old_issue is immediately anonymised
2130
2131 Ideally, this function would be internal to C<C4::Circulation>,
2132 not exported, but it is currently needed by one
2133 routine in C<C4::Accounts>.
2134
2135 =cut
2136
2137 sub MarkIssueReturned {
2138     my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2139
2140     my $anonymouspatron;
2141     if ( $privacy == 2 ) {
2142         # The default of 0 will not work due to foreign key constraints
2143         # The anonymisation will fail if AnonymousPatron is not a valid entry
2144         # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2145         # Note that a warning should appear on the about page (System information tab).
2146         $anonymouspatron = C4::Context->preference('AnonymousPatron');
2147         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."
2148             unless C4::Members::GetMember( borrowernumber => $anonymouspatron );
2149     }
2150     my $database = Koha::Database->new();
2151     my $schema   = $database->schema;
2152     my $dbh   = C4::Context->dbh;
2153
2154     my $issue_id = $dbh->selectrow_array(
2155         q|SELECT issue_id FROM issues WHERE itemnumber = ?|,
2156         undef, $itemnumber
2157     );
2158
2159     my $query = 'UPDATE issues SET returndate=';
2160     my @bind;
2161     if ($dropbox_branch) {
2162         my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2163         my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2164         $query .= ' ? ';
2165         push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2166     } elsif ($returndate) {
2167         $query .= ' ? ';
2168         push @bind, $returndate;
2169     } else {
2170         $query .= ' now() ';
2171     }
2172     $query .= ' WHERE issue_id = ?';
2173     push @bind, $issue_id;
2174
2175     # FIXME Improve the return value and handle it from callers
2176     $schema->txn_do(sub {
2177
2178         $dbh->do( $query, undef, @bind );
2179
2180         my $issue = Koha::Checkouts->find( $issue_id ); # FIXME should be fetched earlier
2181
2182         # Create the old_issues entry
2183         my $old_checkout_data = $issue->unblessed;
2184
2185         if ( Koha::Old::Checkouts->find( $issue_id ) ) {
2186             my $new_issue_id = ( Koha::Old::Checkouts->search(
2187                 {},
2188                 { columns => [ { max_issue_id => { max => 'issue_id' } } ] }
2189             )->get_column('max_issue_id') )[0];
2190             $new_issue_id++;
2191             $issue_id = $new_issue_id;
2192         }
2193         $old_checkout_data->{issue_id} = $issue_id;
2194         my $old_checkout = Koha::Old::Checkout->new($old_checkout_data)->store;
2195
2196         # Update the fines
2197         $dbh->do(q|UPDATE accountlines SET issue_id = ? WHERE issue_id = ?|, undef, $old_checkout->issue_id, $issue->issue_id);
2198
2199         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2200         if ( $privacy == 2) {
2201             $dbh->do(q|UPDATE old_issues SET borrowernumber=? WHERE issue_id = ?|, undef, $anonymouspatron, $old_checkout->issue_id);
2202         }
2203
2204         # Delete the issue
2205         $issue->delete;
2206
2207         ModItem( { 'onloan' => undef }, undef, $itemnumber );
2208
2209         if ( C4::Context->preference('StoreLastBorrower') ) {
2210             my $item = Koha::Items->find( $itemnumber );
2211             my $patron = Koha::Patrons->find( $borrowernumber );
2212             $item->last_returned_by( $patron );
2213         }
2214     });
2215
2216     return $issue_id;
2217 }
2218
2219 =head2 _debar_user_on_return
2220
2221     _debar_user_on_return($borrower, $item, $datedue, today);
2222
2223 C<$borrower> borrower hashref
2224
2225 C<$item> item hashref
2226
2227 C<$datedue> date due DateTime object
2228
2229 C<$return_date> DateTime object representing the return time
2230
2231 Internal function, called only by AddReturn that calculates and updates
2232  the user fine days, and debars them if necessary.
2233
2234 Should only be called for overdue returns
2235
2236 =cut
2237
2238 sub _debar_user_on_return {
2239     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2240
2241     my $branchcode = _GetCircControlBranch( $item, $borrower );
2242
2243     my $circcontrol = C4::Context->preference('CircControl');
2244     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2245         {   categorycode => $borrower->{categorycode},
2246             itemtype     => $item->{itype},
2247             branchcode   => $branchcode
2248         }
2249     );
2250     my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2251     my $unit     = $issuing_rule ? $issuing_rule->lengthunit : undef;
2252     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2253
2254     if ($finedays) {
2255
2256         # finedays is in days, so hourly loans must multiply by 24
2257         # thus 1 hour late equals 1 day suspension * finedays rate
2258         $finedays = $finedays * 24 if ( $unit eq 'hours' );
2259
2260         # grace period is measured in the same units as the loan
2261         my $grace =
2262           DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2263
2264         my $deltadays = DateTime::Duration->new(
2265             days => $chargeable_units
2266         );
2267         if ( $deltadays->subtract($grace)->is_positive() ) {
2268             my $suspension_days = $deltadays * $finedays;
2269
2270             # If the max suspension days is < than the suspension days
2271             # the suspension days is limited to this maximum period.
2272             my $max_sd = $issuing_rule->maxsuspensiondays;
2273             if ( defined $max_sd ) {
2274                 $max_sd = DateTime::Duration->new( days => $max_sd );
2275                 $suspension_days = $max_sd
2276                   if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2277             }
2278
2279             my ( $has_been_extended, $is_a_reminder );
2280             if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2281                 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2282                 if ( $debarment ) {
2283                     $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2284                     $has_been_extended = 1;
2285                 }
2286             }
2287
2288             my $new_debar_dt =
2289               $return_date->clone()->add_duration( $suspension_days );
2290
2291             Koha::Patron::Debarments::AddUniqueDebarment({
2292                 borrowernumber => $borrower->{borrowernumber},
2293                 expiration     => $new_debar_dt->ymd(),
2294                 type           => 'SUSPENSION',
2295             });
2296             # if borrower was already debarred but does not get an extra debarment
2297             my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2298             my $new_debarment_str;
2299             if ( $borrower->{debarred} eq $patron->is_debarred ) {
2300                 $is_a_reminder = 1;
2301                 $new_debarment_str = $borrower->{debarred};
2302             } else {
2303                 $new_debarment_str = $new_debar_dt->ymd();
2304             }
2305             # FIXME Should return a DateTime object
2306             return $new_debarment_str, $is_a_reminder;
2307         }
2308     }
2309     return;
2310 }
2311
2312 =head2 _FixOverduesOnReturn
2313
2314    &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2315
2316 C<$brn> borrowernumber
2317
2318 C<$itm> itemnumber
2319
2320 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2321 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2322
2323 Internal function, called only by AddReturn
2324
2325 =cut
2326
2327 sub _FixOverduesOnReturn {
2328     my ($borrowernumber, $item);
2329     unless ($borrowernumber = shift) {
2330         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2331         return;
2332     }
2333     unless ($item = shift) {
2334         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2335         return;
2336     }
2337     my ($exemptfine, $dropbox) = @_;
2338     my $dbh = C4::Context->dbh;
2339
2340     # check for overdue fine
2341     my $sth = $dbh->prepare(
2342 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2343     );
2344     $sth->execute( $borrowernumber, $item );
2345
2346     # alter fine to show that the book has been returned
2347     my $data = $sth->fetchrow_hashref;
2348     return 0 unless $data;    # no warning, there's just nothing to fix
2349
2350     my $uquery;
2351     my @bind = ($data->{'accountlines_id'});
2352     if ($exemptfine) {
2353         $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2354         if (C4::Context->preference("FinesLog")) {
2355             &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2356         }
2357     } elsif ($dropbox && $data->{lastincrement}) {
2358         my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2359         my $amt = $data->{amount} - $data->{lastincrement} ;
2360         if (C4::Context->preference("FinesLog")) {
2361             &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2362         }
2363          $uquery = "update accountlines set accounttype='F' ";
2364          if($outstanding  >= 0 && $amt >=0) {
2365             $uquery .= ", amount = ? , amountoutstanding=? ";
2366             unshift @bind, ($amt, $outstanding) ;
2367         }
2368     } else {
2369         $uquery = "update accountlines set accounttype='F' ";
2370     }
2371     $uquery .= " where (accountlines_id = ?)";
2372     my $usth = $dbh->prepare($uquery);
2373     return $usth->execute(@bind);
2374 }
2375
2376 =head2 _FixAccountForLostAndReturned
2377
2378   &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2379
2380 Calculates the charge for a book lost and returned.
2381
2382 Internal function, not exported, called only by AddReturn.
2383
2384 FIXME: This function reflects how inscrutable fines logic is.  Fix both.
2385 FIXME: Give a positive return value on success.  It might be the $borrowernumber who received credit, or the amount forgiven.
2386
2387 =cut
2388
2389 sub _FixAccountForLostAndReturned {
2390     my $itemnumber     = shift or return;
2391     my $borrowernumber = @_ ? shift : undef;
2392     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
2393     my $dbh = C4::Context->dbh;
2394     # check for charge made for lost book
2395     my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2396     $sth->execute($itemnumber);
2397     my $data = $sth->fetchrow_hashref;
2398     $data or return;    # bail if there is nothing to do
2399     $data->{accounttype} eq 'W' and return;    # Written off
2400
2401     # writeoff this amount
2402     my $offset;
2403     my $amount = $data->{'amount'};
2404     my $acctno = $data->{'accountno'};
2405     my $amountleft;                                             # Starts off undef/zero.
2406     if ($data->{'amountoutstanding'} == $amount) {
2407         $offset     = $data->{'amount'};
2408         $amountleft = 0;                                        # Hey, it's zero here, too.
2409     } else {
2410         $offset     = $amount - $data->{'amountoutstanding'};   # Um, isn't this the same as ZERO?  We just tested those two things are ==
2411         $amountleft = $data->{'amountoutstanding'} - $amount;   # Um, isn't this the same as ZERO?  We just tested those two things are ==
2412     }
2413     my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2414         WHERE (accountlines_id = ?)");
2415     $usth->execute($data->{'accountlines_id'});      # We might be adjusting an account for some OTHER borrowernumber now.  Not the one we passed in.
2416     #check if any credit is left if so writeoff other accounts
2417     my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2418     $amountleft *= -1 if ($amountleft < 0);
2419     if ($amountleft > 0) {
2420         my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2421                             AND (amountoutstanding >0) ORDER BY date");     # might want to order by amountoustanding ASC (pay smallest first)
2422         $msth->execute($data->{'borrowernumber'});
2423         # offset transactions
2424         my $newamtos;
2425         my $accdata;
2426         while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2427             if ($accdata->{'amountoutstanding'} < $amountleft) {
2428                 $newamtos = 0;
2429                 $amountleft -= $accdata->{'amountoutstanding'};
2430             }  else {
2431                 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2432                 $amountleft = 0;
2433             }
2434             my $thisacct = $accdata->{'accountlines_id'};
2435             # FIXME: move prepares outside while loop!
2436             my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2437                     WHERE (accountlines_id = ?)");
2438             $usth->execute($newamtos,$thisacct);
2439             $usth = $dbh->prepare("INSERT INTO accountoffsets
2440                 (borrowernumber, accountno, offsetaccount,  offsetamount)
2441                 VALUES
2442                 (?,?,?,?)");
2443             $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2444         }
2445     }
2446     $amountleft *= -1 if ($amountleft > 0);
2447     my $desc = "Item Returned " . $item_id;
2448     $usth = $dbh->prepare("INSERT INTO accountlines
2449         (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2450         VALUES (?,?,now(),?,?,'CR',?)");
2451     $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2452     if ($borrowernumber) {
2453         # FIXME: same as query above.  use 1 sth for both
2454         $usth = $dbh->prepare("INSERT INTO accountoffsets
2455             (borrowernumber, accountno, offsetaccount,  offsetamount)
2456             VALUES (?,?,?,?)");
2457         $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2458     }
2459     ModItem({ paidfor => '' }, undef, $itemnumber);
2460     return;
2461 }
2462
2463 =head2 _GetCircControlBranch
2464
2465    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2466
2467 Internal function :
2468
2469 Return the library code to be used to determine which circulation
2470 policy applies to a transaction.  Looks up the CircControl and
2471 HomeOrHoldingBranch system preferences.
2472
2473 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2474
2475 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2476
2477 =cut
2478
2479 sub _GetCircControlBranch {
2480     my ($item, $borrower) = @_;
2481     my $circcontrol = C4::Context->preference('CircControl');
2482     my $branch;
2483
2484     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2485         $branch= C4::Context->userenv->{'branch'};
2486     } elsif ($circcontrol eq 'PatronLibrary') {
2487         $branch=$borrower->{branchcode};
2488     } else {
2489         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2490         $branch = $item->{$branchfield};
2491         # default to item home branch if holdingbranch is used
2492         # and is not defined
2493         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2494             $branch = $item->{homebranch};
2495         }
2496     }
2497     return $branch;
2498 }
2499
2500 =head2 GetOpenIssue
2501
2502   $issue = GetOpenIssue( $itemnumber );
2503
2504 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2505
2506 C<$itemnumber> is the item's itemnumber
2507
2508 Returns a hashref
2509
2510 =cut
2511
2512 sub GetOpenIssue {
2513   my ( $itemnumber ) = @_;
2514   return unless $itemnumber;
2515   my $dbh = C4::Context->dbh;
2516   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2517   $sth->execute( $itemnumber );
2518   return $sth->fetchrow_hashref();
2519
2520 }
2521
2522 =head2 GetBiblioIssues
2523
2524   $issues = GetBiblioIssues($biblionumber);
2525
2526 this function get all issues from a biblionumber.
2527
2528 Return:
2529 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2530 tables issues and the firstname,surname & cardnumber from borrowers.
2531
2532 =cut
2533
2534 sub GetBiblioIssues {
2535     my $biblionumber = shift;
2536     return unless $biblionumber;
2537     my $dbh   = C4::Context->dbh;
2538     my $query = "
2539         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2540         FROM issues
2541             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2542             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2543             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2544             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2545         WHERE biblio.biblionumber = ?
2546         UNION ALL
2547         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2548         FROM old_issues
2549             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2550             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2551             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2552             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2553         WHERE biblio.biblionumber = ?
2554         ORDER BY timestamp
2555     ";
2556     my $sth = $dbh->prepare($query);
2557     $sth->execute($biblionumber, $biblionumber);
2558
2559     my @issues;
2560     while ( my $data = $sth->fetchrow_hashref ) {
2561         push @issues, $data;
2562     }
2563     return \@issues;
2564 }
2565
2566 =head2 GetUpcomingDueIssues
2567
2568   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2569
2570 =cut
2571
2572 sub GetUpcomingDueIssues {
2573     my $params = shift;
2574
2575     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2576     my $dbh = C4::Context->dbh;
2577
2578     my $statement = <<END_SQL;
2579 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2580 FROM issues
2581 LEFT JOIN items USING (itemnumber)
2582 LEFT OUTER JOIN branches USING (branchcode)
2583 WHERE returndate is NULL
2584 HAVING days_until_due >= 0 AND days_until_due <= ?
2585 END_SQL
2586
2587     my @bind_parameters = ( $params->{'days_in_advance'} );
2588
2589     my $sth = $dbh->prepare( $statement );
2590     $sth->execute( @bind_parameters );
2591     my $upcoming_dues = $sth->fetchall_arrayref({});
2592
2593     return $upcoming_dues;
2594 }
2595
2596 =head2 CanBookBeRenewed
2597
2598   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2599
2600 Find out whether a borrowed item may be renewed.
2601
2602 C<$borrowernumber> is the borrower number of the patron who currently
2603 has the item on loan.
2604
2605 C<$itemnumber> is the number of the item to renew.
2606
2607 C<$override_limit>, if supplied with a true value, causes
2608 the limit on the number of times that the loan can be renewed
2609 (as controlled by the item type) to be ignored. Overriding also allows
2610 to renew sooner than "No renewal before" and to manually renew loans
2611 that are automatically renewed.
2612
2613 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2614 item must currently be on loan to the specified borrower; renewals
2615 must be allowed for the item's type; and the borrower must not have
2616 already renewed the loan. $error will contain the reason the renewal can not proceed
2617
2618 =cut
2619
2620 sub CanBookBeRenewed {
2621     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2622
2623     my $dbh    = C4::Context->dbh;
2624     my $renews = 1;
2625
2626     my $item      = GetItem($itemnumber)      or return ( 0, 'no_item' );
2627     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return ( 0, 'no_checkout' );
2628     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2629
2630     $borrowernumber ||= $issue->borrowernumber;
2631     my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
2632       or return;
2633
2634     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2635
2636     # This item can fill one or more unfilled reserve, can those unfilled reserves
2637     # all be filled by other available items?
2638     if ( $resfound
2639         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2640     {
2641         my $schema = Koha::Database->new()->schema();
2642
2643         my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2644         if ($item_holds) {
2645             # There is an item level hold on this item, no other item can fill the hold
2646             $resfound = 1;
2647         }
2648         else {
2649
2650             # Get all other items that could possibly fill reserves
2651             my @itemnumbers = $schema->resultset('Item')->search(
2652                 {
2653                     biblionumber => $resrec->{biblionumber},
2654                     onloan       => undef,
2655                     notforloan   => 0,
2656                     -not         => { itemnumber => $itemnumber }
2657                 },
2658                 { columns => 'itemnumber' }
2659             )->get_column('itemnumber')->all();
2660
2661             # Get all other reserves that could have been filled by this item
2662             my @borrowernumbers;
2663             while (1) {
2664                 my ( $reserve_found, $reserve, undef ) =
2665                   C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2666
2667                 if ($reserve_found) {
2668                     push( @borrowernumbers, $reserve->{borrowernumber} );
2669                 }
2670                 else {
2671                     last;
2672                 }
2673             }
2674
2675             # If the count of the union of the lists of reservable items for each borrower
2676             # is equal or greater than the number of borrowers, we know that all reserves
2677             # can be filled with available items. We can get the union of the sets simply
2678             # by pushing all the elements onto an array and removing the duplicates.
2679             my @reservable;
2680             my %borrowers;
2681             ITEM: foreach my $i (@itemnumbers) {
2682                 my $item = GetItem($i);
2683                 next if IsItemOnHoldAndFound($i);
2684                 for my $b (@borrowernumbers) {
2685                     my $borr = $borrowers{$b}//= C4::Members::GetMember(borrowernumber => $b);
2686                     next unless IsAvailableForItemLevelRequest($item, $borr);
2687                     next unless CanItemBeReserved($b,$i);
2688
2689                     push @reservable, $i;
2690                     if (@reservable >= @borrowernumbers) {
2691                         $resfound = 0;
2692                         last ITEM;
2693                     }
2694                     last;
2695                 }
2696             }
2697         }
2698     }
2699     return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2700
2701     return ( 1, undef ) if $override_limit;
2702
2703     my $branchcode = _GetCircControlBranch( $item, $borrower );
2704     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2705         {   categorycode => $borrower->{categorycode},
2706             itemtype     => $item->{itype},
2707             branchcode   => $branchcode
2708         }
2709     );
2710
2711     return ( 0, "too_many" )
2712       if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2713
2714     my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2715     my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2716     my $patron      = Koha::Patrons->find($borrowernumber);
2717     my $restricted  = $patron->is_debarred;
2718     my $hasoverdues = $patron->has_overdues;
2719
2720     if ( $restricted and $restrictionblockrenewing ) {
2721         return ( 0, 'restriction');
2722     } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2723         return ( 0, 'overdue');
2724     }
2725
2726     if ( $issue->auto_renew ) {
2727         if ( defined $issuing_rule->no_auto_renewal_after
2728                 and $issuing_rule->no_auto_renewal_after ne "" ) {
2729             # Get issue_date and add no_auto_renewal_after
2730             # If this is greater than today, it's too late for renewal.
2731             my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2732             $maximum_renewal_date->add(
2733                 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2734             );
2735             my $now = dt_from_string;
2736             if ( $now >= $maximum_renewal_date ) {
2737                 return ( 0, "auto_too_late" );
2738             }
2739         }
2740         if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2741                       and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2742             # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2743             if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2744                 return ( 0, "auto_too_late" );
2745             }
2746         }
2747
2748         if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2749             my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2750             my ( $amountoutstanding ) = C4::Members::GetMemberAccountRecords($borrower->{borrowernumber});
2751             if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2752                 return ( 0, "auto_too_much_oweing" );
2753             }
2754         }
2755     }
2756
2757     if ( defined $issuing_rule->norenewalbefore
2758         and $issuing_rule->norenewalbefore ne "" )
2759     {
2760
2761         # Calculate soonest renewal by subtracting 'No renewal before' from due date
2762         my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2763             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2764
2765         # Depending on syspref reset the exact time, only check the date
2766         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2767             and $issuing_rule->lengthunit eq 'days' )
2768         {
2769             $soonestrenewal->truncate( to => 'day' );
2770         }
2771
2772         if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2773         {
2774             return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2775             return ( 0, "too_soon" );
2776         }
2777         elsif ( $issue->auto_renew ) {
2778             return ( 0, "auto_renew" );
2779         }
2780     }
2781
2782     # Fallback for automatic renewals:
2783     # If norenewalbefore is undef, don't renew before due date.
2784     if ( $issue->auto_renew ) {
2785         my $now = dt_from_string;
2786         return ( 0, "auto_renew" )
2787           if $now >= dt_from_string( $issue->date_due, 'sql' );
2788         return ( 0, "auto_too_soon" );
2789     }
2790
2791     return ( 1, undef );
2792 }
2793
2794 =head2 AddRenewal
2795
2796   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2797
2798 Renews a loan.
2799
2800 C<$borrowernumber> is the borrower number of the patron who currently
2801 has the item.
2802
2803 C<$itemnumber> is the number of the item to renew.
2804
2805 C<$branch> is the library where the renewal took place (if any).
2806            The library that controls the circ policies for the renewal is retrieved from the issues record.
2807
2808 C<$datedue> can be a DateTime object used to set the due date.
2809
2810 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2811 this parameter is not supplied, lastreneweddate is set to the current date.
2812
2813 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2814 from the book's item type.
2815
2816 =cut
2817
2818 sub AddRenewal {
2819     my $borrowernumber  = shift;
2820     my $itemnumber      = shift or return;
2821     my $branch          = shift;
2822     my $datedue         = shift;
2823     my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2824
2825     my $item   = GetItem($itemnumber) or return;
2826     my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2827
2828     my $dbh = C4::Context->dbh;
2829
2830     # Find the issues record for this book
2831     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
2832
2833     return unless $issue;
2834
2835     $borrowernumber ||= $issue->borrowernumber;
2836
2837     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2838         carp 'Invalid date passed to AddRenewal.';
2839         return;
2840     }
2841
2842     my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2843
2844     if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2845         _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $borrower } );
2846     }
2847     _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2848
2849     # If the due date wasn't specified, calculate it by adding the
2850     # book's loan length to today's date or the current due date
2851     # based on the value of the RenewalPeriodBase syspref.
2852     unless ($datedue) {
2853
2854         my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2855
2856         $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2857                                         dt_from_string( $issue->date_due, 'sql' ) :
2858                                         DateTime->now( time_zone => C4::Context->tz());
2859         $datedue =  CalcDateDue($datedue, $itemtype, _GetCircControlBranch($item, $borrower), $borrower, 'is a renewal');
2860     }
2861
2862     # Update the issues record to have the new due date, and a new count
2863     # of how many times it has been renewed.
2864     my $renews = $issue->renewals + 1;
2865     my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2866                             WHERE borrowernumber=?
2867                             AND itemnumber=?"
2868     );
2869
2870     $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2871
2872     # Update the renewal count on the item, and tell zebra to reindex
2873     $renews = $biblio->{'renewals'} + 1;
2874     ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2875
2876     # Charge a new rental fee, if applicable?
2877     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2878     if ( $charge > 0 ) {
2879         my $accountno = getnextacctno( $borrowernumber );
2880         my $item = GetBiblioFromItemNumber($itemnumber);
2881         my $manager_id = 0;
2882         $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2883         $sth = $dbh->prepare(
2884                 "INSERT INTO accountlines
2885                     (date, borrowernumber, accountno, amount, manager_id,
2886                     description,accounttype, amountoutstanding, itemnumber)
2887                     VALUES (now(),?,?,?,?,?,?,?,?)"
2888         );
2889         $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2890             "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2891             'Rent', $charge, $itemnumber );
2892     }
2893
2894     # Send a renewal slip according to checkout alert preferencei
2895     if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2896         $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
2897         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2898         my %conditions        = (
2899             branchcode   => $branch,
2900             categorycode => $borrower->{categorycode},
2901             item_type    => $item->{itype},
2902             notification => 'CHECKOUT',
2903         );
2904         if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2905             SendCirculationAlert(
2906                 {
2907                     type     => 'RENEWAL',
2908                     item     => $item,
2909                     borrower => $borrower,
2910                     branch   => $branch,
2911                 }
2912             );
2913         }
2914     }
2915
2916     # Remove any OVERDUES related debarment if the borrower has no overdues
2917     $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
2918     if ( $borrowernumber
2919       && $borrower->{'debarred'}
2920       && !Koha::Patrons->find( $borrowernumber )->has_overdues
2921       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2922     ) {
2923         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2924     }
2925
2926     # Add the renewal to stats
2927     UpdateStats(
2928         {
2929             branch => C4::Context->userenv ? C4::Context->userenv->{branch} : $branch,
2930             type           => 'renew',
2931             amount         => $charge,
2932             itemnumber     => $itemnumber,
2933             itemtype       => $item->{itype},
2934             borrowernumber => $borrowernumber,
2935             ccode          => $item->{'ccode'}
2936         }
2937     );
2938
2939     #Log the renewal
2940     logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2941     return $datedue;
2942 }
2943
2944 sub GetRenewCount {
2945     # check renewal status
2946     my ( $bornum, $itemno ) = @_;
2947     my $dbh           = C4::Context->dbh;
2948     my $renewcount    = 0;
2949     my $renewsallowed = 0;
2950     my $renewsleft    = 0;
2951
2952     my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2953     my $item     = GetItem($itemno);
2954
2955     # Look in the issues table for this item, lent to this borrower,
2956     # and not yet returned.
2957
2958     # FIXME - I think this function could be redone to use only one SQL call.
2959     my $sth = $dbh->prepare(
2960         "select * from issues
2961                                 where (borrowernumber = ?)
2962                                 and (itemnumber = ?)"
2963     );
2964     $sth->execute( $bornum, $itemno );
2965     my $data = $sth->fetchrow_hashref;
2966     $renewcount = $data->{'renewals'} if $data->{'renewals'};
2967     # $item and $borrower should be calculated
2968     my $branchcode = _GetCircControlBranch($item, $borrower);
2969
2970     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2971         {   categorycode => $borrower->{categorycode},
2972             itemtype     => $item->{itype},
2973             branchcode   => $branchcode
2974         }
2975     );
2976
2977     $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
2978     $renewsleft    = $renewsallowed - $renewcount;
2979     if($renewsleft < 0){ $renewsleft = 0; }
2980     return ( $renewcount, $renewsallowed, $renewsleft );
2981 }
2982
2983 =head2 GetSoonestRenewDate
2984
2985   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
2986
2987 Find out the soonest possible renew date of a borrowed item.
2988
2989 C<$borrowernumber> is the borrower number of the patron who currently
2990 has the item on loan.
2991
2992 C<$itemnumber> is the number of the item to renew.
2993
2994 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
2995 renew date, based on the value "No renewal before" of the applicable
2996 issuing rule. Returns the current date if the item can already be
2997 renewed, and returns undefined if the borrower, loan, or item
2998 cannot be found.
2999
3000 =cut
3001
3002 sub GetSoonestRenewDate {
3003     my ( $borrowernumber, $itemnumber ) = @_;
3004
3005     my $dbh = C4::Context->dbh;
3006
3007     my $item      = GetItem($itemnumber)      or return;
3008     my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
3009
3010     $borrowernumber ||= $itemissue->borrowernumber;
3011     my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
3012       or return;
3013
3014     my $branchcode = _GetCircControlBranch( $item, $borrower );
3015     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3016         {   categorycode => $borrower->{categorycode},
3017             itemtype     => $item->{itype},
3018             branchcode   => $branchcode
3019         }
3020     );
3021
3022     my $now = dt_from_string;
3023     return $now unless $issuing_rule;
3024
3025     if ( defined $issuing_rule->norenewalbefore
3026         and $issuing_rule->norenewalbefore ne "" )
3027     {
3028         my $soonestrenewal =
3029           dt_from_string( $itemissue->date_due )->subtract(
3030             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3031
3032         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3033             and $issuing_rule->lengthunit eq 'days' )
3034         {
3035             $soonestrenewal->truncate( to => 'day' );
3036         }
3037         return $soonestrenewal if $now < $soonestrenewal;
3038     }
3039     return $now;
3040 }
3041
3042 =head2 GetLatestAutoRenewDate
3043
3044   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3045
3046 Find out the latest possible auto renew date of a borrowed item.
3047
3048 C<$borrowernumber> is the borrower number of the patron who currently
3049 has the item on loan.
3050
3051 C<$itemnumber> is the number of the item to renew.
3052
3053 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3054 auto renew date, based on the value "No auto renewal after" and the "No auto
3055 renewal after (hard limit) of the applicable issuing rule.
3056 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3057 or item cannot be found.
3058
3059 =cut
3060
3061 sub GetLatestAutoRenewDate {
3062     my ( $borrowernumber, $itemnumber ) = @_;
3063
3064     my $dbh = C4::Context->dbh;
3065
3066     my $item      = GetItem($itemnumber)      or return;
3067     my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
3068
3069     $borrowernumber ||= $itemissue->borrowernumber;
3070     my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
3071       or return;
3072
3073     my $branchcode = _GetCircControlBranch( $item, $borrower );
3074     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3075         {   categorycode => $borrower->{categorycode},
3076             itemtype     => $item->{itype},
3077             branchcode   => $branchcode
3078         }
3079     );
3080
3081     return unless $issuing_rule;
3082     return
3083       if ( not $issuing_rule->no_auto_renewal_after
3084             or $issuing_rule->no_auto_renewal_after eq '' )
3085       and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3086              or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3087
3088     my $maximum_renewal_date;
3089     if ( $issuing_rule->no_auto_renewal_after ) {
3090         $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3091         $maximum_renewal_date->add(
3092             $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3093         );
3094     }
3095
3096     if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3097         my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3098         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3099     }
3100     return $maximum_renewal_date;
3101 }
3102
3103
3104 =head2 GetIssuingCharges
3105
3106   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3107
3108 Calculate how much it would cost for a given patron to borrow a given
3109 item, including any applicable discounts.
3110
3111 C<$itemnumber> is the item number of item the patron wishes to borrow.
3112
3113 C<$borrowernumber> is the patron's borrower number.
3114
3115 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3116 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3117 if it's a video).
3118
3119 =cut
3120
3121 sub GetIssuingCharges {
3122
3123     # calculate charges due
3124     my ( $itemnumber, $borrowernumber ) = @_;
3125     my $charge = 0;
3126     my $dbh    = C4::Context->dbh;
3127     my $item_type;
3128
3129     # Get the book's item type and rental charge (via its biblioitem).
3130     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3131         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3132     $charge_query .= (C4::Context->preference('item-level_itypes'))
3133         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3134         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3135
3136     $charge_query .= ' WHERE items.itemnumber =?';
3137
3138     my $sth = $dbh->prepare($charge_query);
3139     $sth->execute($itemnumber);
3140     if ( my $item_data = $sth->fetchrow_hashref ) {
3141         $item_type = $item_data->{itemtype};
3142         $charge    = $item_data->{rentalcharge};
3143         my $branch = C4::Context::mybranch();
3144         my $discount_query = q|SELECT rentaldiscount,
3145             issuingrules.itemtype, issuingrules.branchcode
3146             FROM borrowers
3147             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3148             WHERE borrowers.borrowernumber = ?
3149             AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3150             AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3151         my $discount_sth = $dbh->prepare($discount_query);
3152         $discount_sth->execute( $borrowernumber, $item_type, $branch );
3153         my $discount_rules = $discount_sth->fetchall_arrayref({});
3154         if (@{$discount_rules}) {
3155             # We may have multiple rules so get the most specific
3156             my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3157             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3158         }
3159         if ($charge) {
3160             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3161         }
3162     }
3163
3164     return ( $charge, $item_type );
3165 }
3166
3167 # Select most appropriate discount rule from those returned
3168 sub _get_discount_from_rule {
3169     my ($rules_ref, $branch, $itemtype) = @_;
3170     my $discount;
3171
3172     if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3173         $discount = $rules_ref->[0]->{rentaldiscount};
3174         return (defined $discount) ? $discount : 0;
3175     }
3176     # could have up to 4 does one match $branch and $itemtype
3177     my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3178     if (@d) {
3179         $discount = $d[0]->{rentaldiscount};
3180         return (defined $discount) ? $discount : 0;
3181     }
3182     # do we have item type + all branches
3183     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3184     if (@d) {
3185         $discount = $d[0]->{rentaldiscount};
3186         return (defined $discount) ? $discount : 0;
3187     }
3188     # do we all item types + this branch
3189     @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3190     if (@d) {
3191         $discount = $d[0]->{rentaldiscount};
3192         return (defined $discount) ? $discount : 0;
3193     }
3194     # so all and all (surely we wont get here)
3195     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3196     if (@d) {
3197         $discount = $d[0]->{rentaldiscount};
3198         return (defined $discount) ? $discount : 0;
3199     }
3200     # none of the above
3201     return 0;
3202 }
3203
3204 =head2 AddIssuingCharge
3205
3206   &AddIssuingCharge( $itemno, $borrowernumber, $charge )
3207
3208 =cut
3209
3210 sub AddIssuingCharge {
3211     my ( $itemnumber, $borrowernumber, $charge ) = @_;
3212     my $dbh = C4::Context->dbh;
3213     my $nextaccntno = getnextacctno( $borrowernumber );
3214     my $manager_id = 0;
3215     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3216     my $query ="
3217         INSERT INTO accountlines
3218             (borrowernumber, itemnumber, accountno,
3219             date, amount, description, accounttype,
3220             amountoutstanding, manager_id)
3221         VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
3222     ";
3223     my $sth = $dbh->prepare($query);
3224     $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
3225 }
3226
3227 =head2 GetTransfers
3228
3229   GetTransfers($itemnumber);
3230
3231 =cut
3232
3233 sub GetTransfers {
3234     my ($itemnumber) = @_;
3235
3236     my $dbh = C4::Context->dbh;
3237
3238     my $query = '
3239         SELECT datesent,
3240                frombranch,
3241                tobranch,
3242                branchtransfer_id
3243         FROM branchtransfers
3244         WHERE itemnumber = ?
3245           AND datearrived IS NULL
3246         ';
3247     my $sth = $dbh->prepare($query);
3248     $sth->execute($itemnumber);
3249     my @row = $sth->fetchrow_array();
3250     return @row;
3251 }
3252
3253 =head2 GetTransfersFromTo
3254
3255   @results = GetTransfersFromTo($frombranch,$tobranch);
3256
3257 Returns the list of pending transfers between $from and $to branch
3258
3259 =cut
3260
3261 sub GetTransfersFromTo {
3262     my ( $frombranch, $tobranch ) = @_;
3263     return unless ( $frombranch && $tobranch );
3264     my $dbh   = C4::Context->dbh;
3265     my $query = "
3266         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3267         FROM   branchtransfers
3268         WHERE  frombranch=?
3269           AND  tobranch=?
3270           AND datearrived IS NULL
3271     ";
3272     my $sth = $dbh->prepare($query);
3273     $sth->execute( $frombranch, $tobranch );
3274     my @gettransfers;
3275
3276     while ( my $data = $sth->fetchrow_hashref ) {
3277         push @gettransfers, $data;
3278     }
3279     return (@gettransfers);
3280 }
3281
3282 =head2 DeleteTransfer
3283
3284   &DeleteTransfer($itemnumber);
3285
3286 =cut
3287
3288 sub DeleteTransfer {
3289     my ($itemnumber) = @_;
3290     return unless $itemnumber;
3291     my $dbh          = C4::Context->dbh;
3292     my $sth          = $dbh->prepare(
3293         "DELETE FROM branchtransfers
3294          WHERE itemnumber=?
3295          AND datearrived IS NULL "
3296     );
3297     return $sth->execute($itemnumber);
3298 }
3299
3300 =head2 SendCirculationAlert
3301
3302 Send out a C<check-in> or C<checkout> alert using the messaging system.
3303
3304 B<Parameters>:
3305
3306 =over 4
3307
3308 =item type
3309
3310 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3311
3312 =item item
3313
3314 Hashref of information about the item being checked in or out.
3315
3316 =item borrower
3317
3318 Hashref of information about the borrower of the item.
3319
3320 =item branch
3321
3322 The branchcode from where the checkout or check-in took place.
3323
3324 =back
3325
3326 B<Example>:
3327
3328     SendCirculationAlert({
3329         type     => 'CHECKOUT',
3330         item     => $item,
3331         borrower => $borrower,
3332         branch   => $branch,
3333     });
3334
3335 =cut
3336
3337 sub SendCirculationAlert {
3338     my ($opts) = @_;
3339     my ($type, $item, $borrower, $branch) =
3340         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3341     my %message_name = (
3342         CHECKIN  => 'Item_Check_in',
3343         CHECKOUT => 'Item_Checkout',
3344         RENEWAL  => 'Item_Checkout',
3345     );
3346     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3347         borrowernumber => $borrower->{borrowernumber},
3348         message_name   => $message_name{$type},
3349     });
3350     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3351
3352     my $schema = Koha::Database->new->schema;
3353     my @transports = keys %{ $borrower_preferences->{transports} };
3354
3355     # From the MySQL doc:
3356     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3357     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3358     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3359     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3360
3361     for my $mtt (@transports) {
3362         my $letter =  C4::Letters::GetPreparedLetter (
3363             module => 'circulation',
3364             letter_code => $type,
3365             branchcode => $branch,
3366             message_transport_type => $mtt,
3367             lang => $borrower->{lang},
3368             tables => {
3369                 $issues_table => $item->{itemnumber},
3370                 'items'       => $item->{itemnumber},
3371                 'biblio'      => $item->{biblionumber},
3372                 'biblioitems' => $item->{biblionumber},
3373                 'borrowers'   => $borrower,
3374                 'branches'    => $branch,
3375             }
3376         ) or next;
3377
3378         $schema->storage->txn_begin;
3379         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3380         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3381         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3382         unless ( $message ) {
3383             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3384             C4::Message->enqueue($letter, $borrower, $mtt);
3385         } else {
3386             $message->append($letter);
3387             $message->update;
3388         }
3389         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3390         $schema->storage->txn_commit;
3391     }
3392
3393     return;
3394 }
3395
3396 =head2 updateWrongTransfer
3397
3398   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3399
3400 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
3401
3402 =cut
3403
3404 sub updateWrongTransfer {
3405         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3406         my $dbh = C4::Context->dbh;
3407 # first step validate the actual line of transfert .
3408         my $sth =
3409                 $dbh->prepare(
3410                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3411                 );
3412                 $sth->execute($FromLibrary,$itemNumber);
3413
3414 # second step create a new line of branchtransfer to the right location .
3415         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3416
3417 #third step changing holdingbranch of item
3418         UpdateHoldingbranch($FromLibrary,$itemNumber);
3419 }
3420
3421 =head2 UpdateHoldingbranch
3422
3423   $items = UpdateHoldingbranch($branch,$itmenumber);
3424
3425 Simple methode for updating hodlingbranch in items BDD line
3426
3427 =cut
3428
3429 sub UpdateHoldingbranch {
3430         my ( $branch,$itemnumber ) = @_;
3431     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3432 }
3433
3434 =head2 CalcDateDue
3435
3436 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3437
3438 this function calculates the due date given the start date and configured circulation rules,
3439 checking against the holidays calendar as per the 'useDaysMode' syspref.
3440 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3441 C<$itemtype>  = itemtype code of item in question
3442 C<$branch>  = location whose calendar to use
3443 C<$borrower> = Borrower object
3444 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3445
3446 =cut
3447
3448 sub CalcDateDue {
3449     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3450
3451     $isrenewal ||= 0;
3452
3453     # loanlength now a href
3454     my $loanlength =
3455             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3456
3457     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3458             ? qq{renewalperiod}
3459             : qq{issuelength};
3460
3461     my $datedue;
3462     if ( $startdate ) {
3463         if (ref $startdate ne 'DateTime' ) {
3464             $datedue = dt_from_string($datedue);
3465         } else {
3466             $datedue = $startdate->clone;
3467         }
3468     } else {
3469         $datedue =
3470           DateTime->now( time_zone => C4::Context->tz() )
3471           ->truncate( to => 'minute' );
3472     }
3473
3474
3475     # calculate the datedue as normal
3476     if ( C4::Context->preference('useDaysMode') eq 'Days' )
3477     {    # ignoring calendar
3478         if ( $loanlength->{lengthunit} eq 'hours' ) {
3479             $datedue->add( hours => $loanlength->{$length_key} );
3480         } else {    # days
3481             $datedue->add( days => $loanlength->{$length_key} );
3482             $datedue->set_hour(23);
3483             $datedue->set_minute(59);
3484         }
3485     } else {
3486         my $dur;
3487         if ($loanlength->{lengthunit} eq 'hours') {
3488             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3489         }
3490         else { # days
3491             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3492         }
3493         my $calendar = Koha::Calendar->new( branchcode => $branch );
3494         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3495         if ($loanlength->{lengthunit} eq 'days') {
3496             $datedue->set_hour(23);
3497             $datedue->set_minute(59);
3498         }
3499     }
3500
3501     # if Hard Due Dates are used, retrieve them and apply as necessary
3502     my ( $hardduedate, $hardduedatecompare ) =
3503       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3504     if ($hardduedate) {    # hardduedates are currently dates
3505         $hardduedate->truncate( to => 'minute' );
3506         $hardduedate->set_hour(23);
3507         $hardduedate->set_minute(59);
3508         my $cmp = DateTime->compare( $hardduedate, $datedue );
3509
3510 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3511 # if the calculated date is before the 'after' Hard Due Date (floor), override
3512 # if the hard due date is set to 'exactly', overrride
3513         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3514             $datedue = $hardduedate->clone;
3515         }
3516
3517         # in all other cases, keep the date due as it is
3518
3519     }
3520
3521     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3522     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3523         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3524         if( $expiry_dt ) { #skip empty expiry date..
3525             $expiry_dt->set( hour => 23, minute => 59);
3526             my $d1= $datedue->clone->set_time_zone('floating');
3527             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3528                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3529             }
3530         }
3531     }
3532
3533     return $datedue;
3534 }
3535
3536
3537 sub CheckValidBarcode{
3538 my ($barcode) = @_;
3539 my $dbh = C4::Context->dbh;
3540 my $query=qq|SELECT count(*)
3541              FROM items
3542              WHERE barcode=?
3543             |;
3544 my $sth = $dbh->prepare($query);
3545 $sth->execute($barcode);
3546 my $exist=$sth->fetchrow ;
3547 return $exist;
3548 }
3549
3550 =head2 IsBranchTransferAllowed
3551
3552   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3553
3554 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3555
3556 =cut
3557
3558 sub IsBranchTransferAllowed {
3559         my ( $toBranch, $fromBranch, $code ) = @_;
3560
3561         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3562
3563         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3564         my $dbh = C4::Context->dbh;
3565
3566         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3567         $sth->execute( $toBranch, $fromBranch, $code );
3568         my $limit = $sth->fetchrow_hashref();
3569
3570         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3571         if ( $limit->{'limitId'} ) {
3572                 return 0;
3573         } else {
3574                 return 1;
3575         }
3576 }
3577
3578 =head2 CreateBranchTransferLimit
3579
3580   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3581
3582 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3583
3584 =cut
3585
3586 sub CreateBranchTransferLimit {
3587    my ( $toBranch, $fromBranch, $code ) = @_;
3588    return unless defined($toBranch) && defined($fromBranch);
3589    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3590
3591    my $dbh = C4::Context->dbh;
3592
3593    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3594    return $sth->execute( $code, $toBranch, $fromBranch );
3595 }
3596
3597 =head2 DeleteBranchTransferLimits
3598
3599     my $result = DeleteBranchTransferLimits($frombranch);
3600
3601 Deletes all the library transfer limits for one library.  Returns the
3602 number of limits deleted, 0e0 if no limits were deleted, or undef if
3603 no arguments are supplied.
3604
3605 =cut
3606
3607 sub DeleteBranchTransferLimits {
3608     my $branch = shift;
3609     return unless defined $branch;
3610     my $dbh    = C4::Context->dbh;
3611     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3612     return $sth->execute($branch);
3613 }
3614
3615 sub ReturnLostItem{
3616     my ( $borrowernumber, $itemnum ) = @_;
3617
3618     MarkIssueReturned( $borrowernumber, $itemnum );
3619     my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3620     my $item = C4::Items::GetItem( $itemnum );
3621     my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3622     my @datearr = localtime(time);
3623     my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3624     my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3625     ModItem({ paidfor =>  $old_note."Paid for by $bor $date" }, undef, $itemnum);
3626 }
3627
3628
3629 sub LostItem{
3630     my ($itemnumber, $mark_returned) = @_;
3631
3632     my $dbh = C4::Context->dbh();
3633     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3634                            FROM issues
3635                            JOIN items USING (itemnumber)
3636                            JOIN biblio USING (biblionumber)
3637                            WHERE issues.itemnumber=?");
3638     $sth->execute($itemnumber);
3639     my $issues=$sth->fetchrow_hashref();
3640
3641     # If a borrower lost the item, add a replacement cost to the their record
3642     if ( my $borrowernumber = $issues->{borrowernumber} ){
3643         my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
3644
3645         if (C4::Context->preference('WhenLostForgiveFine')){
3646             my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3647             defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3648         }
3649         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3650             C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3651             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3652             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3653         }
3654
3655         MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3656     }
3657 }
3658
3659 sub GetOfflineOperations {
3660     my $dbh = C4::Context->dbh;
3661     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3662     $sth->execute(C4::Context->userenv->{'branch'});
3663     my $results = $sth->fetchall_arrayref({});
3664     return $results;
3665 }
3666
3667 sub GetOfflineOperation {
3668     my $operationid = shift;
3669     return unless $operationid;
3670     my $dbh = C4::Context->dbh;
3671     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3672     $sth->execute( $operationid );
3673     return $sth->fetchrow_hashref;
3674 }
3675
3676 sub AddOfflineOperation {
3677     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3678     my $dbh = C4::Context->dbh;
3679     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3680     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3681     return "Added.";
3682 }
3683
3684 sub DeleteOfflineOperation {
3685     my $dbh = C4::Context->dbh;
3686     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3687     $sth->execute( shift );
3688     return "Deleted.";
3689 }
3690
3691 sub ProcessOfflineOperation {
3692     my $operation = shift;
3693
3694     my $report;
3695     if ( $operation->{action} eq 'return' ) {
3696         $report = ProcessOfflineReturn( $operation );
3697     } elsif ( $operation->{action} eq 'issue' ) {
3698         $report = ProcessOfflineIssue( $operation );
3699     } elsif ( $operation->{action} eq 'payment' ) {
3700         $report = ProcessOfflinePayment( $operation );
3701     }
3702
3703     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3704
3705     return $report;
3706 }
3707
3708 sub ProcessOfflineReturn {
3709     my $operation = shift;
3710
3711     my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3712
3713     if ( $itemnumber ) {
3714         my $issue = GetOpenIssue( $itemnumber );
3715         if ( $issue ) {
3716             MarkIssueReturned(
3717                 $issue->{borrowernumber},
3718                 $itemnumber,
3719                 undef,
3720                 $operation->{timestamp},
3721             );
3722             ModItem(
3723                 { renewals => 0, onloan => undef },
3724                 $issue->{'biblionumber'},
3725                 $itemnumber
3726             );
3727             return "Success.";
3728         } else {
3729             return "Item not issued.";
3730         }
3731     } else {
3732         return "Item not found.";
3733     }
3734 }
3735
3736 sub ProcessOfflineIssue {
3737     my $operation = shift;
3738
3739     my $borrower = C4::Members::GetMember( cardnumber => $operation->{cardnumber} );
3740
3741     if ( $borrower->{borrowernumber} ) {
3742         my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3743         unless ($itemnumber) {
3744             return "Barcode not found.";
3745         }
3746         my $issue = GetOpenIssue( $itemnumber );
3747
3748         if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3749             MarkIssueReturned(
3750                 $issue->{borrowernumber},
3751                 $itemnumber,
3752                 undef,
3753                 $operation->{timestamp},
3754             );
3755         }
3756         AddIssue(
3757             $borrower,
3758             $operation->{'barcode'},
3759             undef,
3760             1,
3761             $operation->{timestamp},
3762             undef,
3763         );
3764         return "Success.";
3765     } else {
3766         return "Borrower not found.";
3767     }
3768 }
3769
3770 sub ProcessOfflinePayment {
3771     my $operation = shift;
3772
3773     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} });
3774     my $amount = $operation->{amount};
3775
3776     Koha::Account->new( { patron_id => $patron->id } )->pay( { amount => $amount } );
3777
3778     return "Success."
3779 }
3780
3781
3782 =head2 TransferSlip
3783
3784   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3785
3786   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3787
3788 =cut
3789
3790 sub TransferSlip {
3791     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3792
3793     my $item =  GetItem( $itemnumber, $barcode )
3794       or return;
3795
3796     return C4::Letters::GetPreparedLetter (
3797         module => 'circulation',
3798         letter_code => 'TRANSFERSLIP',
3799         branchcode => $branch,
3800         tables => {
3801             'branches'    => $to_branch,
3802             'biblio'      => $item->{biblionumber},
3803             'items'       => $item,
3804         },
3805     );
3806 }
3807
3808 =head2 CheckIfIssuedToPatron
3809
3810   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3811
3812   Return 1 if any record item is issued to patron, otherwise return 0
3813
3814 =cut
3815
3816 sub CheckIfIssuedToPatron {
3817     my ($borrowernumber, $biblionumber) = @_;
3818
3819     my $dbh = C4::Context->dbh;
3820     my $query = q|
3821         SELECT COUNT(*) FROM issues
3822         LEFT JOIN items ON items.itemnumber = issues.itemnumber
3823         WHERE items.biblionumber = ?
3824         AND issues.borrowernumber = ?
3825     |;
3826     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3827     return 1 if $is_issued;
3828     return;
3829 }
3830
3831 =head2 IsItemIssued
3832
3833   IsItemIssued( $itemnumber )
3834
3835   Return 1 if the item is on loan, otherwise return 0
3836
3837 =cut
3838
3839 sub IsItemIssued {
3840     my $itemnumber = shift;
3841     my $dbh = C4::Context->dbh;
3842     my $sth = $dbh->prepare(q{
3843         SELECT COUNT(*)
3844         FROM issues
3845         WHERE itemnumber = ?
3846     });
3847     $sth->execute($itemnumber);
3848     return $sth->fetchrow;
3849 }
3850
3851 =head2 GetAgeRestriction
3852
3853   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3854   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3855
3856   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3857   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3858
3859 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3860 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3861 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3862          Negative days mean the borrower has gone past the age restriction age.
3863
3864 =cut
3865
3866 sub GetAgeRestriction {
3867     my ($record_restrictions, $borrower) = @_;
3868     my $markers = C4::Context->preference('AgeRestrictionMarker');
3869
3870     # Split $record_restrictions to something like FSK 16 or PEGI 6
3871     my @values = split ' ', uc($record_restrictions);
3872     return unless @values;
3873
3874     # Search first occurrence of one of the markers
3875     my @markers = split /\|/, uc($markers);
3876     return unless @markers;
3877
3878     my $index            = 0;
3879     my $restriction_year = 0;
3880     for my $value (@values) {
3881         $index++;
3882         for my $marker (@markers) {
3883             $marker =~ s/^\s+//;    #remove leading spaces
3884             $marker =~ s/\s+$//;    #remove trailing spaces
3885             if ( $marker eq $value ) {
3886                 if ( $index <= $#values ) {
3887                     $restriction_year += $values[$index];
3888                 }
3889                 last;
3890             }
3891             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3892
3893                 # Perhaps it is something like "K16" (as in Finland)
3894                 $restriction_year += $1;
3895                 last;
3896             }
3897         }
3898         last if ( $restriction_year > 0 );
3899     }
3900
3901     #Check if the borrower is age restricted for this material and for how long.
3902     if ($restriction_year && $borrower) {
3903         if ( $borrower->{'dateofbirth'} ) {
3904             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3905             $alloweddate[0] += $restriction_year;
3906
3907             #Prevent runime eror on leap year (invalid date)
3908             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3909                 $alloweddate[2] = 28;
3910             }
3911
3912             #Get how many days the borrower has to reach the age restriction
3913             my @Today = split /-/, DateTime->today->ymd();
3914             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
3915             #Negative days means the borrower went past the age restriction age
3916             return ($restriction_year, $daysToAgeRestriction);
3917         }
3918     }
3919
3920     return ($restriction_year);
3921 }
3922
3923
3924 =head2 GetPendingOnSiteCheckouts
3925
3926 =cut
3927
3928 sub GetPendingOnSiteCheckouts {
3929     my $dbh = C4::Context->dbh;
3930     return $dbh->selectall_arrayref(q|
3931         SELECT
3932           items.barcode,
3933           items.biblionumber,
3934           items.itemnumber,
3935           items.itemnotes,
3936           items.itemcallnumber,
3937           items.location,
3938           issues.date_due,
3939           issues.branchcode,
3940           issues.date_due < NOW() AS is_overdue,
3941           biblio.author,
3942           biblio.title,
3943           borrowers.firstname,
3944           borrowers.surname,
3945           borrowers.cardnumber,
3946           borrowers.borrowernumber
3947         FROM items
3948         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
3949         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
3950         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
3951         WHERE issues.onsite_checkout = 1
3952     |, { Slice => {} } );
3953 }
3954
3955 sub GetTopIssues {
3956     my ($params) = @_;
3957
3958     my ($count, $branch, $itemtype, $ccode, $newness)
3959         = @$params{qw(count branch itemtype ccode newness)};
3960
3961     my $dbh = C4::Context->dbh;
3962     my $query = q{
3963         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
3964           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
3965           i.ccode, SUM(i.issues) AS count
3966         FROM biblio b
3967         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
3968         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
3969     };
3970
3971     my (@where_strs, @where_args);
3972
3973     if ($branch) {
3974         push @where_strs, 'i.homebranch = ?';
3975         push @where_args, $branch;
3976     }
3977     if ($itemtype) {
3978         if (C4::Context->preference('item-level_itypes')){
3979             push @where_strs, 'i.itype = ?';
3980             push @where_args, $itemtype;
3981         } else {
3982             push @where_strs, 'bi.itemtype = ?';
3983             push @where_args, $itemtype;
3984         }
3985     }
3986     if ($ccode) {
3987         push @where_strs, 'i.ccode = ?';
3988         push @where_args, $ccode;
3989     }
3990     if ($newness) {
3991         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
3992         push @where_args, $newness;
3993     }
3994
3995     if (@where_strs) {
3996         $query .= 'WHERE ' . join(' AND ', @where_strs);
3997     }
3998
3999     $query .= q{
4000         GROUP BY b.biblionumber
4001         HAVING count > 0
4002         ORDER BY count DESC
4003     };
4004
4005     $count = int($count);
4006     if ($count > 0) {
4007         $query .= "LIMIT $count";
4008     }
4009
4010     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4011
4012     return @$rows;
4013 }
4014
4015 sub _CalculateAndUpdateFine {
4016     my ($params) = @_;
4017
4018     my $borrower    = $params->{borrower};
4019     my $item        = $params->{item};
4020     my $issue       = $params->{issue};
4021     my $return_date = $params->{return_date};
4022
4023     unless ($borrower) { carp "No borrower passed in!" && return; }
4024     unless ($item)     { carp "No item passed in!"     && return; }
4025     unless ($issue)    { carp "No issue passed in!"    && return; }
4026
4027     my $datedue = dt_from_string( $issue->date_due );
4028
4029     # we only need to calculate and change the fines if we want to do that on return
4030     # Should be on for hourly loans
4031     my $control = C4::Context->preference('CircControl');
4032     my $control_branchcode =
4033         ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4034       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4035       :                                     $issue->branchcode;
4036
4037     my $date_returned = $return_date ? dt_from_string($return_date) : dt_from_string();
4038
4039     my ( $amount, $type, $unitcounttotal ) =
4040       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4041
4042     $type ||= q{};
4043
4044     if ( C4::Context->preference('finesMode') eq 'production' ) {
4045         if ( $amount > 0 ) {
4046             C4::Overdues::UpdateFine({
4047                 issue_id       => $issue->issue_id,
4048                 itemnumber     => $issue->itemnumber,
4049                 borrowernumber => $issue->borrowernumber,
4050                 amount         => $amount,
4051                 type           => $type,
4052                 due            => output_pref($datedue),
4053             });
4054         }
4055         elsif ($return_date) {
4056
4057             # Backdated returns may have fines that shouldn't exist,
4058             # so in this case, we need to drop those fines to 0
4059
4060             C4::Overdues::UpdateFine({
4061                 issue_id       => $issue->issue_id,
4062                 itemnumber     => $issue->itemnumber,
4063                 borrowernumber => $issue->borrowernumber,
4064                 amount         => 0,
4065                 type           => $type,
4066                 due            => output_pref($datedue),
4067             });
4068         }
4069     }
4070 }
4071
4072 1;
4073
4074 __END__
4075
4076 =head1 AUTHOR
4077
4078 Koha Development Team <http://koha-community.org/>
4079
4080 =cut