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