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