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 =
1360               Koha::Checkouts->find( { itemnumber => $item->{'itemnumber'} } );
1361             if ($issue) {
1362                 $issue->set(
1363                     {
1364                         borrowernumber => $borrower->{'borrowernumber'},
1365                         issuedate  => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1366                         date_due   => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1367                         branchcode => C4::Context->userenv->{'branch'},
1368                         onsite_checkout => $onsite_checkout,
1369                         auto_renew      => $auto_renew ? 1 : 0
1370                     }
1371                 )->store;
1372             }
1373             else {
1374                 $issue = Koha::Checkout->new(
1375                     {
1376                         borrowernumber => $borrower->{'borrowernumber'},
1377                         itemnumber     => $item->{'itemnumber'},
1378                         issuedate  => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1379                         date_due   => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1380                         branchcode => C4::Context->userenv->{'branch'},
1381                         onsite_checkout => $onsite_checkout,
1382                         auto_renew      => $auto_renew ? 1 : 0
1383                     }
1384                 )->store;
1385             }
1386
1387             if ( C4::Context->preference('ReturnToShelvingCart') ) {
1388                 # ReturnToShelvingCart is on, anything issued should be taken off the cart.
1389                 CartToShelf( $item->{'itemnumber'} );
1390             }
1391             $item->{'issues'}++;
1392             if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1393                 UpdateTotalIssues( $item->{'biblionumber'}, 1 );
1394             }
1395
1396             ## If item was lost, it has now been found, reverse any list item charges if necessary.
1397             if ( $item->{'itemlost'} ) {
1398                 if (
1399                     Koha::RefundLostItemFeeRules->should_refund(
1400                         {
1401                             current_branch      => C4::Context->userenv->{branch},
1402                             item_home_branch    => $item->{homebranch},
1403                             item_holding_branch => $item->{holdingbranch}
1404                         }
1405                     )
1406                   )
1407                 {
1408                     _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef,
1409                         $item->{'barcode'} );
1410                 }
1411             }
1412
1413             ModItem(
1414                 {
1415                     issues        => $item->{'issues'},
1416                     holdingbranch => C4::Context->userenv->{'branch'},
1417                     itemlost      => 0,
1418                     onloan        => $datedue->ymd(),
1419                     datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1420                 },
1421                 $item->{'biblionumber'},
1422                 $item->{'itemnumber'},
1423                 { log_action => 0 }
1424             );
1425             ModDateLastSeen( $item->{'itemnumber'} );
1426
1427            # If it costs to borrow this book, charge it to the patron's account.
1428             my ( $charge, $itemtype ) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
1429             if ( $charge > 0 ) {
1430                 AddIssuingCharge( $issue, $charge );
1431                 $item->{'charge'} = $charge;
1432             }
1433
1434             # Record the fact that this book was issued.
1435             &UpdateStats(
1436                 {
1437                     branch => C4::Context->userenv->{'branch'},
1438                     type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1439                     amount         => $charge,
1440                     other          => ( $sipmode ? "SIP-$sipmode" : '' ),
1441                     itemnumber     => $item->{'itemnumber'},
1442                     itemtype       => $item->{'itype'},
1443                     location       => $item->{location},
1444                     borrowernumber => $borrower->{'borrowernumber'},
1445                     ccode          => $item->{'ccode'}
1446                 }
1447             );
1448
1449             # Send a checkout slip.
1450             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1451             my %conditions        = (
1452                 branchcode   => $branch,
1453                 categorycode => $borrower->{categorycode},
1454                 item_type    => $item->{itype},
1455                 notification => 'CHECKOUT',
1456             );
1457             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1458                 SendCirculationAlert(
1459                     {
1460                         type     => 'CHECKOUT',
1461                         item     => $item,
1462                         borrower => $borrower,
1463                         branch   => $branch,
1464                     }
1465                 );
1466             }
1467             logaction(
1468                 "CIRCULATION", "ISSUE",
1469                 $borrower->{'borrowernumber'},
1470                 $item->{'itemnumber'}
1471             ) if C4::Context->preference("IssueLog");
1472         }
1473     }
1474     return $issue;
1475 }
1476
1477 =head2 GetLoanLength
1478
1479   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1480
1481 Get loan length for an itemtype, a borrower type and a branch
1482
1483 =cut
1484
1485 sub GetLoanLength {
1486     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1487     my $dbh = C4::Context->dbh;
1488     my $sth = $dbh->prepare(qq{
1489         SELECT issuelength, lengthunit, renewalperiod
1490         FROM issuingrules
1491         WHERE   categorycode=?
1492             AND itemtype=?
1493             AND branchcode=?
1494             AND issuelength IS NOT NULL
1495     });
1496
1497     # try to find issuelength & return the 1st available.
1498     # check with borrowertype, itemtype and branchcode, then without one of those parameters
1499     $sth->execute( $borrowertype, $itemtype, $branchcode );
1500     my $loanlength = $sth->fetchrow_hashref;
1501
1502     return $loanlength
1503       if defined($loanlength) && defined $loanlength->{issuelength};
1504
1505     $sth->execute( $borrowertype, '*', $branchcode );
1506     $loanlength = $sth->fetchrow_hashref;
1507     return $loanlength
1508       if defined($loanlength) && defined $loanlength->{issuelength};
1509
1510     $sth->execute( '*', $itemtype, $branchcode );
1511     $loanlength = $sth->fetchrow_hashref;
1512     return $loanlength
1513       if defined($loanlength) && defined $loanlength->{issuelength};
1514
1515     $sth->execute( '*', '*', $branchcode );
1516     $loanlength = $sth->fetchrow_hashref;
1517     return $loanlength
1518       if defined($loanlength) && defined $loanlength->{issuelength};
1519
1520     $sth->execute( $borrowertype, $itemtype, '*' );
1521     $loanlength = $sth->fetchrow_hashref;
1522     return $loanlength
1523       if defined($loanlength) && defined $loanlength->{issuelength};
1524
1525     $sth->execute( $borrowertype, '*', '*' );
1526     $loanlength = $sth->fetchrow_hashref;
1527     return $loanlength
1528       if defined($loanlength) && defined $loanlength->{issuelength};
1529
1530     $sth->execute( '*', $itemtype, '*' );
1531     $loanlength = $sth->fetchrow_hashref;
1532     return $loanlength
1533       if defined($loanlength) && defined $loanlength->{issuelength};
1534
1535     $sth->execute( '*', '*', '*' );
1536     $loanlength = $sth->fetchrow_hashref;
1537     return $loanlength
1538       if defined($loanlength) && defined $loanlength->{issuelength};
1539
1540     # if no rule is set => 0 day (hardcoded)
1541     return {
1542         issuelength => 0,
1543         renewalperiod => 0,
1544         lengthunit => 'days',
1545     };
1546
1547 }
1548
1549
1550 =head2 GetHardDueDate
1551
1552   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1553
1554 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1555
1556 =cut
1557
1558 sub GetHardDueDate {
1559     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1560
1561     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1562         {   categorycode => $borrowertype,
1563             itemtype     => $itemtype,
1564             branchcode   => $branchcode
1565         }
1566     );
1567
1568
1569     if ( defined( $issuing_rule ) ) {
1570         if ( $issuing_rule->hardduedate ) {
1571             return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1572         } else {
1573             return (undef, undef);
1574         }
1575     }
1576 }
1577
1578 =head2 GetBranchBorrowerCircRule
1579
1580   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1581
1582 Retrieves circulation rule attributes that apply to the given
1583 branch and patron category, regardless of item type.
1584 The return value is a hashref containing the following key:
1585
1586 maxissueqty - maximum number of loans that a
1587 patron of the given category can have at the given
1588 branch.  If the value is undef, no limit.
1589
1590 maxonsiteissueqty - maximum of on-site checkouts that a
1591 patron of the given category can have at the given
1592 branch.  If the value is undef, no limit.
1593
1594 This will first check for a specific branch and
1595 category match from branch_borrower_circ_rules.
1596
1597 If no rule is found, it will then check default_branch_circ_rules
1598 (same branch, default category).  If no rule is found,
1599 it will then check default_borrower_circ_rules (default
1600 branch, same category), then failing that, default_circ_rules
1601 (default branch, default category).
1602
1603 If no rule has been found in the database, it will default to
1604 the buillt in rule:
1605
1606 maxissueqty - undef
1607 maxonsiteissueqty - undef
1608
1609 C<$branchcode> and C<$categorycode> should contain the
1610 literal branch code and patron category code, respectively - no
1611 wildcards.
1612
1613 =cut
1614
1615 sub GetBranchBorrowerCircRule {
1616     my ( $branchcode, $categorycode ) = @_;
1617
1618     my $rules;
1619     my $dbh = C4::Context->dbh();
1620     $rules = $dbh->selectrow_hashref( q|
1621         SELECT maxissueqty, maxonsiteissueqty
1622         FROM branch_borrower_circ_rules
1623         WHERE branchcode = ?
1624         AND   categorycode = ?
1625     |, {}, $branchcode, $categorycode ) ;
1626     return $rules if $rules;
1627
1628     # try same branch, default borrower category
1629     $rules = $dbh->selectrow_hashref( q|
1630         SELECT maxissueqty, maxonsiteissueqty
1631         FROM default_branch_circ_rules
1632         WHERE branchcode = ?
1633     |, {}, $branchcode ) ;
1634     return $rules if $rules;
1635
1636     # try default branch, same borrower category
1637     $rules = $dbh->selectrow_hashref( q|
1638         SELECT maxissueqty, maxonsiteissueqty
1639         FROM default_borrower_circ_rules
1640         WHERE categorycode = ?
1641     |, {}, $categorycode ) ;
1642     return $rules if $rules;
1643
1644     # try default branch, default borrower category
1645     $rules = $dbh->selectrow_hashref( q|
1646         SELECT maxissueqty, maxonsiteissueqty
1647         FROM default_circ_rules
1648     |, {} );
1649     return $rules if $rules;
1650
1651     # built-in default circulation rule
1652     return {
1653         maxissueqty => undef,
1654         maxonsiteissueqty => undef,
1655     };
1656 }
1657
1658 =head2 GetBranchItemRule
1659
1660   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1661
1662 Retrieves circulation rule attributes that apply to the given
1663 branch and item type, regardless of patron category.
1664
1665 The return value is a hashref containing the following keys:
1666
1667 holdallowed => Hold policy for this branch and itemtype. Possible values:
1668   0: No holds allowed.
1669   1: Holds allowed only by patrons that have the same homebranch as the item.
1670   2: Holds allowed from any patron.
1671
1672 returnbranch => branch to which to return item.  Possible values:
1673   noreturn: do not return, let item remain where checked in (floating collections)
1674   homebranch: return to item's home branch
1675   holdingbranch: return to issuer branch
1676
1677 This searches branchitemrules in the following order:
1678
1679   * Same branchcode and itemtype
1680   * Same branchcode, itemtype '*'
1681   * branchcode '*', same itemtype
1682   * branchcode and itemtype '*'
1683
1684 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1685
1686 =cut
1687
1688 sub GetBranchItemRule {
1689     my ( $branchcode, $itemtype ) = @_;
1690     my $dbh = C4::Context->dbh();
1691     my $result = {};
1692
1693     my @attempts = (
1694         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1695             FROM branch_item_rules
1696             WHERE branchcode = ?
1697               AND itemtype = ?', $branchcode, $itemtype],
1698         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1699             FROM default_branch_circ_rules
1700             WHERE branchcode = ?', $branchcode],
1701         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1702             FROM default_branch_item_rules
1703             WHERE itemtype = ?', $itemtype],
1704         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1705             FROM default_circ_rules'],
1706     );
1707
1708     foreach my $attempt (@attempts) {
1709         my ($query, @bind_params) = @{$attempt};
1710         my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1711           or next;
1712
1713         # Since branch/category and branch/itemtype use the same per-branch
1714         # defaults tables, we have to check that the key we want is set, not
1715         # just that a row was returned
1716         $result->{'holdallowed'}  = $search_result->{'holdallowed'}  unless ( defined $result->{'holdallowed'} );
1717         $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1718         $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1719     }
1720
1721     # built-in default circulation rule
1722     $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1723     $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1724     $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1725
1726     return $result;
1727 }
1728
1729 =head2 AddReturn
1730
1731   ($doreturn, $messages, $iteminformation, $borrower) =
1732       &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1733
1734 Returns a book.
1735
1736 =over 4
1737
1738 =item C<$barcode> is the bar code of the book being returned.
1739
1740 =item C<$branch> is the code of the branch where the book is being returned.
1741
1742 =item C<$exemptfine> indicates that overdue charges for the item will be
1743 removed. Optional.
1744
1745 =item C<$dropbox> indicates that the check-in date is assumed to be
1746 yesterday, or the last non-holiday as defined in C4::Calendar .  If
1747 overdue charges are applied and C<$dropbox> is true, the last charge
1748 will be removed.  This assumes that the fines accrual script has run
1749 for _today_. Optional.
1750
1751 =item C<$return_date> allows the default return date to be overridden
1752 by the given return date. Optional.
1753
1754 =back
1755
1756 C<&AddReturn> returns a list of four items:
1757
1758 C<$doreturn> is true iff the return succeeded.
1759
1760 C<$messages> is a reference-to-hash giving feedback on the operation.
1761 The keys of the hash are:
1762
1763 =over 4
1764
1765 =item C<BadBarcode>
1766
1767 No item with this barcode exists. The value is C<$barcode>.
1768
1769 =item C<NotIssued>
1770
1771 The book is not currently on loan. The value is C<$barcode>.
1772
1773 =item C<withdrawn>
1774
1775 This book has been withdrawn/cancelled. The value should be ignored.
1776
1777 =item C<Wrongbranch>
1778
1779 This book has was returned to the wrong branch.  The value is a hashref
1780 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1781 contain the branchcode of the incorrect and correct return library, respectively.
1782
1783 =item C<ResFound>
1784
1785 The item was reserved. The value is a reference-to-hash whose keys are
1786 fields from the reserves table of the Koha database, and
1787 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1788 either C<Waiting>, C<Reserved>, or 0.
1789
1790 =item C<WasReturned>
1791
1792 Value 1 if return is successful.
1793
1794 =item C<NeedsTransfer>
1795
1796 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1797
1798 =back
1799
1800 C<$iteminformation> is a reference-to-hash, giving information about the
1801 returned item from the issues table.
1802
1803 C<$borrower> is a reference-to-hash, giving information about the
1804 patron who last borrowed the book.
1805
1806 =cut
1807
1808 sub AddReturn {
1809     my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1810
1811     if ($branch and not Koha::Libraries->find($branch)) {
1812         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1813         undef $branch;
1814     }
1815     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1816     my $messages;
1817     my $patron;
1818     my $doreturn       = 1;
1819     my $validTransfert = 0;
1820     my $stat_type = 'return';
1821
1822     # get information on item
1823     my $item = GetItem( undef, $barcode );
1824     unless ($item) {
1825         return ( 0, { BadBarcode => $barcode } );    # no barcode means no item or borrower.  bail out.
1826     }
1827
1828     my $itemnumber = $item->{ itemnumber };
1829     my $itemtype = $item->{itype}; # GetItem called effective_itemtype
1830
1831     my $issue  = Koha::Checkouts->find( { itemnumber => $itemnumber } );
1832     if ( $issue ) {
1833         $patron = Koha::Patrons->find( $issue->borrowernumber )
1834             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1835                 . Dumper($issue->unblessed) . "\n";
1836     } else {
1837         $messages->{'NotIssued'} = $barcode;
1838         ModItem({ onloan => undef }, $item->{biblionumber}, $item->{itemnumber}) if defined $item->{onloan};
1839         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1840         $doreturn = 0;
1841         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1842         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1843         if (C4::Context->preference("RecordLocalUseOnReturn")) {
1844            $messages->{'LocalUse'} = 1;
1845            $stat_type = 'localuse';
1846         }
1847     }
1848
1849     if ( $item->{'location'} eq 'PROC' ) {
1850         if ( C4::Context->preference("InProcessingToShelvingCart") ) {
1851             $item->{'location'} = 'CART';
1852         }
1853         else {
1854             $item->{location} = $item->{permanent_location};
1855         }
1856
1857         ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'}, { log_action => 0 } );
1858     }
1859
1860         # full item data, but no borrowernumber or checkout info (no issue)
1861     my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1862         # get the proper branch to which to return the item
1863     my $returnbranch = $item->{$hbr} || $branch ;
1864         # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1865
1866     my $borrowernumber = $patron ? $patron->borrowernumber : undef;    # we don't know if we had a borrower or not
1867     my $patron_unblessed = $patron ? $patron->unblessed : {};
1868
1869     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1870     if ($yaml) {
1871         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
1872         my $rules;
1873         eval { $rules = YAML::Load($yaml); };
1874         if ($@) {
1875             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1876         }
1877         else {
1878             foreach my $key ( keys %$rules ) {
1879                 if ( $item->{notforloan} eq $key ) {
1880                     $messages->{'NotForLoanStatusUpdated'} = { from => $item->{notforloan}, to => $rules->{$key} };
1881                     ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber, { log_action => 0 } );
1882                     last;
1883                 }
1884             }
1885         }
1886     }
1887
1888     # check if the return is allowed at this branch
1889     my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1890     unless ($returnallowed){
1891         $messages->{'Wrongbranch'} = {
1892             Wrongbranch => $branch,
1893             Rightbranch => $message
1894         };
1895         $doreturn = 0;
1896         return ( $doreturn, $messages, $issue, $patron_unblessed);
1897     }
1898
1899     if ( $item->{'withdrawn'} ) { # book has been cancelled
1900         $messages->{'withdrawn'} = 1;
1901         $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1902     }
1903
1904     if ( $item->{itemlost} and C4::Context->preference("BlockReturnOfLostItems") ) {
1905         $doreturn = 0;
1906     }
1907
1908     # case of a return of document (deal with issues and holdingbranch)
1909     my $today = DateTime->now( time_zone => C4::Context->tz() );
1910
1911     if ($doreturn) {
1912         my $is_overdue;
1913         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1914         $patron or warn "AddReturn without current borrower";
1915                 my $circControlBranch;
1916         if ($dropbox) {
1917             # define circControlBranch only if dropbox mode is set
1918             # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1919             # FIXME: check issuedate > returndate, factoring in holidays
1920
1921             $circControlBranch = _GetCircControlBranch($item,$patron_unblessed);
1922             $is_overdue = $issue->is_overdue( $dropboxdate );
1923         } else {
1924             $is_overdue = $issue->is_overdue;
1925         }
1926
1927         if ($patron) {
1928             eval {
1929                 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1930                     $circControlBranch, $return_date, $patron->privacy );
1931             };
1932             unless ( $@ ) {
1933                 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $is_overdue ) || $return_date ) {
1934                     _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $patron_unblessed, return_date => $return_date } );
1935                 }
1936             } else {
1937                 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 );
1938
1939                 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1940             }
1941
1942             # FIXME is the "= 1" right?  This could be the borrower hash.
1943             $messages->{'WasReturned'} = 1;
1944
1945         }
1946
1947         ModItem( { onloan => undef }, $item->{biblionumber}, $item->{itemnumber}, { log_action => 0 } );
1948     }
1949
1950     # the holdingbranch is updated if the document is returned to another location.
1951     # this is always done regardless of whether the item was on loan or not
1952     my $item_holding_branch = $item->{ holdingbranch };
1953     if ($item->{'holdingbranch'} ne $branch) {
1954         UpdateHoldingbranch($branch, $item->{'itemnumber'});
1955         $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1956     }
1957
1958     my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
1959     ModDateLastSeen( $item->{itemnumber}, $leave_item_lost );
1960
1961     # check if we have a transfer for this document
1962     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1963
1964     # if we have a transfer to do, we update the line of transfers with the datearrived
1965     my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->{'itemnumber'} );
1966     if ($datesent) {
1967         if ( $tobranch eq $branch ) {
1968             my $sth = C4::Context->dbh->prepare(
1969                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1970             );
1971             $sth->execute( $item->{'itemnumber'} );
1972             # if we have a reservation with valid transfer, we can set it's status to 'W'
1973             ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1974             C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1975         } else {
1976             $messages->{'WrongTransfer'}     = $tobranch;
1977             $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1978         }
1979         $validTransfert = 1;
1980     } else {
1981         ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1982     }
1983
1984     # fix up the accounts.....
1985     if ( $item->{'itemlost'} ) {
1986         $messages->{'WasLost'} = 1;
1987         unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
1988             if (
1989                 Koha::RefundLostItemFeeRules->should_refund(
1990                     {
1991                         current_branch      => C4::Context->userenv->{branch},
1992                         item_home_branch    => $item->{homebranch},
1993                         item_holding_branch => $item_holding_branch
1994                     }
1995                 )
1996               )
1997             {
1998                 _FixAccountForLostAndReturned( $item->{'itemnumber'},
1999                     $borrowernumber, $barcode );
2000                 $messages->{'LostItemFeeRefunded'} = 1;
2001             }
2002         }
2003     }
2004
2005     # fix up the overdues in accounts...
2006     if ($borrowernumber) {
2007         my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
2008         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!";  # zero is OK, check defined
2009
2010         if ( $issue and $issue->is_overdue ) {
2011         # fix fine days
2012             $today = dt_from_string($return_date) if $return_date;
2013             $today = $dropboxdate if $dropbox;
2014             my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item, dt_from_string($issue->date_due), $today );
2015             if ($reminder){
2016                 $messages->{'PrevDebarred'} = $debardate;
2017             } else {
2018                 $messages->{'Debarred'} = $debardate if $debardate;
2019             }
2020         # there's no overdue on the item but borrower had been previously debarred
2021         } elsif ( $issue->date_due and $patron->debarred ) {
2022              if ( $patron->debarred eq "9999-12-31") {
2023                 $messages->{'ForeverDebarred'} = $patron->debarred;
2024              } else {
2025                   my $borrower_debar_dt = dt_from_string( $patron->debarred );
2026                   $borrower_debar_dt->truncate(to => 'day');
2027                   my $today_dt = $today->clone()->truncate(to => 'day');
2028                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2029                       $messages->{'PrevDebarred'} = $patron->debarred;
2030                   }
2031              }
2032         }
2033     }
2034
2035     # find reserves.....
2036     # if we don't have a reserve with the status W, we launch the Checkreserves routine
2037     my ($resfound, $resrec);
2038     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2039     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
2040     if ($resfound) {
2041           $resrec->{'ResFound'} = $resfound;
2042         $messages->{'ResFound'} = $resrec;
2043     }
2044
2045     # Record the fact that this book was returned.
2046     UpdateStats({
2047         branch         => $branch,
2048         type           => $stat_type,
2049         itemnumber     => $itemnumber,
2050         itemtype       => $itemtype,
2051         borrowernumber => $borrowernumber,
2052         ccode          => $item->{ ccode }
2053     });
2054
2055     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2056     if ( $patron ) {
2057         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2058         my %conditions = (
2059             branchcode   => $branch,
2060             categorycode => $patron->categorycode,
2061             item_type    => $item->{itype},
2062             notification => 'CHECKIN',
2063         );
2064         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2065             SendCirculationAlert({
2066                 type     => 'CHECKIN',
2067                 item     => $item,
2068                 borrower => $patron->unblessed,
2069                 branch   => $branch,
2070             });
2071         }
2072
2073         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2074             if C4::Context->preference("ReturnLog");
2075         }
2076
2077     # Remove any OVERDUES related debarment if the borrower has no overdues
2078     if ( $borrowernumber
2079       && $patron->debarred
2080       && C4::Context->preference('AutoRemoveOverduesRestrictions')
2081       && !Koha::Patrons->find( $borrowernumber )->has_overdues
2082       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2083     ) {
2084         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2085     }
2086
2087     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2088     if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2089         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2090             (C4::Context->preference("UseBranchTransferLimits") and
2091              ! IsBranchTransferAllowed($branch, $returnbranch, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2092            )) {
2093             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $returnbranch;
2094             $debug and warn "item: " . Dumper($item);
2095             ModItemTransfer($item->{'itemnumber'}, $branch, $returnbranch);
2096             $messages->{'WasTransfered'} = 1;
2097         } else {
2098             $messages->{'NeedsTransfer'} = $returnbranch;
2099         }
2100     }
2101
2102     return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2103 }
2104
2105 =head2 MarkIssueReturned
2106
2107   MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2108
2109 Unconditionally marks an issue as being returned by
2110 moving the C<issues> row to C<old_issues> and
2111 setting C<returndate> to the current date, or
2112 the last non-holiday date of the branccode specified in
2113 C<dropbox_branch> .  Assumes you've already checked that
2114 it's safe to do this, i.e. last non-holiday > issuedate.
2115
2116 if C<$returndate> is specified (in iso format), it is used as the date
2117 of the return. It is ignored when a dropbox_branch is passed in.
2118
2119 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2120 the old_issue is immediately anonymised
2121
2122 Ideally, this function would be internal to C<C4::Circulation>,
2123 not exported, but it is currently needed by one
2124 routine in C<C4::Accounts>.
2125
2126 =cut
2127
2128 sub MarkIssueReturned {
2129     my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2130
2131
2132     # Retrieve the issue
2133     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2134     my $issue_id = $issue->issue_id;
2135
2136     my $anonymouspatron;
2137     if ( $privacy == 2 ) {
2138         # The default of 0 will not work due to foreign key constraints
2139         # The anonymisation will fail if AnonymousPatron is not a valid entry
2140         # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2141         # Note that a warning should appear on the about page (System information tab).
2142         $anonymouspatron = C4::Context->preference('AnonymousPatron');
2143         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."
2144             unless Koha::Patrons->find( $anonymouspatron );
2145     }
2146     my $database = Koha::Database->new();
2147     my $schema   = $database->schema;
2148     my $dbh   = C4::Context->dbh;
2149
2150     my $query = 'UPDATE issues SET returndate=';
2151     my @bind;
2152     if ($dropbox_branch) {
2153         my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2154         my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2155         $query .= ' ? ';
2156         push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2157     } elsif ($returndate) {
2158         $query .= ' ? ';
2159         push @bind, $returndate;
2160     } else {
2161         $query .= ' now() ';
2162     }
2163     $query .= ' WHERE issue_id = ?';
2164     push @bind, $issue_id;
2165
2166     # FIXME Improve the return value and handle it from callers
2167     $schema->txn_do(sub {
2168
2169         # Update the returndate
2170         $dbh->do( $query, undef, @bind );
2171
2172         # We just updated the returndate, so we need to refetch $issue
2173         $issue->discard_changes;
2174
2175         # Create the old_issues entry
2176         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2177
2178         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2179         if ( $privacy == 2) {
2180             $dbh->do(q|UPDATE old_issues SET borrowernumber=? WHERE issue_id = ?|, undef, $anonymouspatron, $old_checkout->issue_id);
2181         }
2182
2183         # And finally delete the issue
2184         $issue->delete;
2185
2186         ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2187
2188         if ( C4::Context->preference('StoreLastBorrower') ) {
2189             my $item = Koha::Items->find( $itemnumber );
2190             my $patron = Koha::Patrons->find( $borrowernumber );
2191             $item->last_returned_by( $patron );
2192         }
2193     });
2194
2195     return $issue_id;
2196 }
2197
2198 =head2 _debar_user_on_return
2199
2200     _debar_user_on_return($borrower, $item, $datedue, today);
2201
2202 C<$borrower> borrower hashref
2203
2204 C<$item> item hashref
2205
2206 C<$datedue> date due DateTime object
2207
2208 C<$return_date> DateTime object representing the return time
2209
2210 Internal function, called only by AddReturn that calculates and updates
2211  the user fine days, and debars them if necessary.
2212
2213 Should only be called for overdue returns
2214
2215 =cut
2216
2217 sub _debar_user_on_return {
2218     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2219
2220     my $branchcode = _GetCircControlBranch( $item, $borrower );
2221
2222     my $circcontrol = C4::Context->preference('CircControl');
2223     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2224         {   categorycode => $borrower->{categorycode},
2225             itemtype     => $item->{itype},
2226             branchcode   => $branchcode
2227         }
2228     );
2229     my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2230     my $unit     = $issuing_rule ? $issuing_rule->lengthunit : undef;
2231     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2232
2233     if ($finedays) {
2234
2235         # finedays is in days, so hourly loans must multiply by 24
2236         # thus 1 hour late equals 1 day suspension * finedays rate
2237         $finedays = $finedays * 24 if ( $unit eq 'hours' );
2238
2239         # grace period is measured in the same units as the loan
2240         my $grace =
2241           DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2242
2243         my $deltadays = DateTime::Duration->new(
2244             days => $chargeable_units
2245         );
2246         if ( $deltadays->subtract($grace)->is_positive() ) {
2247             my $suspension_days = $deltadays * $finedays;
2248
2249             # If the max suspension days is < than the suspension days
2250             # the suspension days is limited to this maximum period.
2251             my $max_sd = $issuing_rule->maxsuspensiondays;
2252             if ( defined $max_sd ) {
2253                 $max_sd = DateTime::Duration->new( days => $max_sd );
2254                 $suspension_days = $max_sd
2255                   if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2256             }
2257
2258             my ( $has_been_extended, $is_a_reminder );
2259             if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2260                 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2261                 if ( $debarment ) {
2262                     $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2263                     $has_been_extended = 1;
2264                 }
2265             }
2266
2267             if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2268                 # No need to / 1 and do not consider / 0
2269                 $suspension_days = DateTime::Duration->new(
2270                     days => floor( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2271                 );
2272             }
2273
2274             my $new_debar_dt;
2275             # Use the calendar or not to calculate the debarment date
2276             if ( C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed' ) {
2277                 my $calendar = Koha::Calendar->new(
2278                     branchcode => $branchcode,
2279                     days_mode  => 'Calendar'
2280                 );
2281                 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2282             }
2283             else {
2284                 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2285             }
2286
2287             Koha::Patron::Debarments::AddUniqueDebarment({
2288                 borrowernumber => $borrower->{borrowernumber},
2289                 expiration     => $new_debar_dt->ymd(),
2290                 type           => 'SUSPENSION',
2291             });
2292             # if borrower was already debarred but does not get an extra debarment
2293             my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2294             my $new_debarment_str;
2295             if ( $borrower->{debarred} eq $patron->is_debarred ) {
2296                 $is_a_reminder = 1;
2297                 $new_debarment_str = $borrower->{debarred};
2298             } else {
2299                 $new_debarment_str = $new_debar_dt->ymd();
2300             }
2301             # FIXME Should return a DateTime object
2302             return $new_debarment_str, $is_a_reminder;
2303         }
2304     }
2305     return;
2306 }
2307
2308 =head2 _FixOverduesOnReturn
2309
2310    &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2311
2312 C<$brn> borrowernumber
2313
2314 C<$itm> itemnumber
2315
2316 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2317 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2318
2319 Internal function
2320
2321 =cut
2322
2323 sub _FixOverduesOnReturn {
2324     my ($borrowernumber, $item, $exemptfine, $dropbox ) = @_;
2325     unless( $borrowernumber ) {
2326         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2327         return;
2328     }
2329     unless( $item ) {
2330         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2331         return;
2332     }
2333
2334     # check for overdue fine
2335     my $accountline = Koha::Account::Lines->search(
2336         {
2337             borrowernumber => $borrowernumber,
2338             itemnumber     => $item,
2339             -or            => [
2340                 accounttype => 'FU',
2341                 accounttype => 'O',
2342             ],
2343         }
2344     )->next();
2345     return 0 unless $accountline;    # no warning, there's just nothing to fix
2346
2347     if ($exemptfine) {
2348         my $amountoutstanding = $accountline->amountoutstanding;
2349
2350         $accountline->accounttype('FFOR');
2351         $accountline->amountoutstanding(0);
2352
2353         Koha::Account::Offset->new(
2354             {
2355                 debit_id => $accountline->id,
2356                 type => 'Forgiven',
2357                 amount => $amountoutstanding * -1,
2358             }
2359         )->store();
2360
2361         if (C4::Context->preference("FinesLog")) {
2362             &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2363         }
2364     } elsif ($dropbox && $accountline->lastincrement) {
2365         my $outstanding = $accountline->amountoutstanding - $accountline->lastincrement;
2366         my $amt = $accountline->amount - $accountline->lastincrement;
2367
2368         Koha::Account::Offset->new(
2369             {
2370                 debit_id => $accountline->id,
2371                 type => 'Dropbox',
2372                 amount => $accountline->lastincrement * -1,
2373             }
2374         )->store();
2375
2376         if ( C4::Context->preference("FinesLog") ) {
2377             &logaction( "FINES", 'MODIFY', $borrowernumber,
2378                 "Dropbox adjustment $amt, item $item" );
2379         }
2380
2381         $accountline->accounttype('F');
2382
2383         if ( $outstanding >= 0 && $amt >= 0 ) {
2384             $accountline->amount($amt);
2385             $accountline->amountoutstanding($outstanding);
2386         }
2387
2388     } else {
2389         $accountline->accounttype('F');
2390     }
2391
2392     return $accountline->store();
2393 }
2394
2395 =head2 _FixAccountForLostAndReturned
2396
2397   &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2398
2399 Calculates the charge for a book lost and returned.
2400
2401 Internal function, not exported, called only by AddReturn.
2402
2403 =cut
2404
2405 sub _FixAccountForLostAndReturned {
2406     my $itemnumber     = shift or return;
2407     my $borrowernumber = @_ ? shift : undef;
2408     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
2409
2410     my $credit;
2411
2412     # check for charge made for lost book
2413     my $accountlines = Koha::Account::Lines->search(
2414         {
2415             itemnumber  => $itemnumber,
2416             accounttype => { -in => [ 'L', 'Rep', 'W' ] },
2417         },
2418         {
2419             order_by => { -desc => [ 'date', 'accountno' ] }
2420         }
2421     );
2422
2423     return unless $accountlines->count > 0;
2424     my $accountline     = $accountlines->next;
2425     my $total_to_refund = 0;
2426     my $account = Koha::Patrons->find( $accountline->borrowernumber )->account;
2427
2428     # Use cases
2429     if ( $accountline->amount > $accountline->amountoutstanding ) {
2430         # some amount has been cancelled. collect the offsets that are not writeoffs
2431         # this works because the only way to subtract from this kind of a debt is
2432         # using the UI buttons 'Pay' and 'Write off'
2433         my $credits_offsets = Koha::Account::Offsets->search({
2434             debit_id  => $accountline->id,
2435             credit_id => { '!=' => undef }, # it is not the debit itself
2436             type      => { '!=' => 'Writeoff' },
2437             amount    => { '<'  => 0 } # credits are negative on the DB
2438         });
2439
2440         $total_to_refund = ( $credits_offsets->count > 0 )
2441                             ? $credits_offsets->total * -1 # credits are negative on the DB
2442                             : 0;
2443     }
2444
2445     my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2446
2447     if ( $credit_total > 0 ) {
2448         my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2449         $credit = $account->add_credit(
2450             {   amount      => $credit_total,
2451                 description => 'Item Returned ' . $item_id,
2452                 type        => 'lost_item_return',
2453                 library_id  => $branchcode
2454             }
2455         );
2456
2457         # TODO: ->apply should just accept the accountline
2458         $credit->apply( { debits => $accountlines->reset } );
2459     }
2460
2461     # Manually set the accounttype
2462     $accountline->discard_changes->accounttype('LR');
2463     $accountline->store;
2464
2465     ModItem( { paidfor => '' }, undef, $itemnumber, { log_action => 0 } );
2466
2467     if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2468         $account->reconcile_balance;
2469     }
2470
2471     return ($credit) ? $credit->id : undef;
2472 }
2473
2474 =head2 _GetCircControlBranch
2475
2476    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2477
2478 Internal function :
2479
2480 Return the library code to be used to determine which circulation
2481 policy applies to a transaction.  Looks up the CircControl and
2482 HomeOrHoldingBranch system preferences.
2483
2484 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2485
2486 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2487
2488 =cut
2489
2490 sub _GetCircControlBranch {
2491     my ($item, $borrower) = @_;
2492     my $circcontrol = C4::Context->preference('CircControl');
2493     my $branch;
2494
2495     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2496         $branch= C4::Context->userenv->{'branch'};
2497     } elsif ($circcontrol eq 'PatronLibrary') {
2498         $branch=$borrower->{branchcode};
2499     } else {
2500         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2501         $branch = $item->{$branchfield};
2502         # default to item home branch if holdingbranch is used
2503         # and is not defined
2504         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2505             $branch = $item->{homebranch};
2506         }
2507     }
2508     return $branch;
2509 }
2510
2511 =head2 GetOpenIssue
2512
2513   $issue = GetOpenIssue( $itemnumber );
2514
2515 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2516
2517 C<$itemnumber> is the item's itemnumber
2518
2519 Returns a hashref
2520
2521 =cut
2522
2523 sub GetOpenIssue {
2524   my ( $itemnumber ) = @_;
2525   return unless $itemnumber;
2526   my $dbh = C4::Context->dbh;
2527   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2528   $sth->execute( $itemnumber );
2529   return $sth->fetchrow_hashref();
2530
2531 }
2532
2533 =head2 GetBiblioIssues
2534
2535   $issues = GetBiblioIssues($biblionumber);
2536
2537 this function get all issues from a biblionumber.
2538
2539 Return:
2540 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2541 tables issues and the firstname,surname & cardnumber from borrowers.
2542
2543 =cut
2544
2545 sub GetBiblioIssues {
2546     my $biblionumber = shift;
2547     return unless $biblionumber;
2548     my $dbh   = C4::Context->dbh;
2549     my $query = "
2550         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2551         FROM issues
2552             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2553             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2554             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2555             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2556         WHERE biblio.biblionumber = ?
2557         UNION ALL
2558         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2559         FROM old_issues
2560             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2561             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2562             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2563             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2564         WHERE biblio.biblionumber = ?
2565         ORDER BY timestamp
2566     ";
2567     my $sth = $dbh->prepare($query);
2568     $sth->execute($biblionumber, $biblionumber);
2569
2570     my @issues;
2571     while ( my $data = $sth->fetchrow_hashref ) {
2572         push @issues, $data;
2573     }
2574     return \@issues;
2575 }
2576
2577 =head2 GetUpcomingDueIssues
2578
2579   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2580
2581 =cut
2582
2583 sub GetUpcomingDueIssues {
2584     my $params = shift;
2585
2586     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2587     my $dbh = C4::Context->dbh;
2588
2589     my $statement = <<END_SQL;
2590 SELECT *
2591 FROM (
2592     SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2593     FROM issues
2594     LEFT JOIN items USING (itemnumber)
2595     LEFT OUTER JOIN branches USING (branchcode)
2596     WHERE returndate is NULL
2597 ) tmp
2598 WHERE days_until_due >= 0 AND days_until_due <= ?
2599 END_SQL
2600
2601     my @bind_parameters = ( $params->{'days_in_advance'} );
2602
2603     my $sth = $dbh->prepare( $statement );
2604     $sth->execute( @bind_parameters );
2605     my $upcoming_dues = $sth->fetchall_arrayref({});
2606
2607     return $upcoming_dues;
2608 }
2609
2610 =head2 CanBookBeRenewed
2611
2612   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2613
2614 Find out whether a borrowed item may be renewed.
2615
2616 C<$borrowernumber> is the borrower number of the patron who currently
2617 has the item on loan.
2618
2619 C<$itemnumber> is the number of the item to renew.
2620
2621 C<$override_limit>, if supplied with a true value, causes
2622 the limit on the number of times that the loan can be renewed
2623 (as controlled by the item type) to be ignored. Overriding also allows
2624 to renew sooner than "No renewal before" and to manually renew loans
2625 that are automatically renewed.
2626
2627 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2628 item must currently be on loan to the specified borrower; renewals
2629 must be allowed for the item's type; and the borrower must not have
2630 already renewed the loan. $error will contain the reason the renewal can not proceed
2631
2632 =cut
2633
2634 sub CanBookBeRenewed {
2635     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2636
2637     my $dbh    = C4::Context->dbh;
2638     my $renews = 1;
2639
2640     my $item      = GetItem($itemnumber)      or return ( 0, 'no_item' );
2641     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return ( 0, 'no_checkout' );
2642     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2643     return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2644
2645
2646     $borrowernumber ||= $issue->borrowernumber;
2647     my $patron = Koha::Patrons->find( $borrowernumber )
2648       or return;
2649
2650     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2651
2652     # This item can fill one or more unfilled reserve, can those unfilled reserves
2653     # all be filled by other available items?
2654     if ( $resfound
2655         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2656     {
2657         my $schema = Koha::Database->new()->schema();
2658
2659         my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2660         if ($item_holds) {
2661             # There is an item level hold on this item, no other item can fill the hold
2662             $resfound = 1;
2663         }
2664         else {
2665
2666             # Get all other items that could possibly fill reserves
2667             my @itemnumbers = $schema->resultset('Item')->search(
2668                 {
2669                     biblionumber => $resrec->{biblionumber},
2670                     onloan       => undef,
2671                     notforloan   => 0,
2672                     -not         => { itemnumber => $itemnumber }
2673                 },
2674                 { columns => 'itemnumber' }
2675             )->get_column('itemnumber')->all();
2676
2677             # Get all other reserves that could have been filled by this item
2678             my @borrowernumbers;
2679             while (1) {
2680                 my ( $reserve_found, $reserve, undef ) =
2681                   C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2682
2683                 if ($reserve_found) {
2684                     push( @borrowernumbers, $reserve->{borrowernumber} );
2685                 }
2686                 else {
2687                     last;
2688                 }
2689             }
2690
2691             # If the count of the union of the lists of reservable items for each borrower
2692             # is equal or greater than the number of borrowers, we know that all reserves
2693             # can be filled with available items. We can get the union of the sets simply
2694             # by pushing all the elements onto an array and removing the duplicates.
2695             my @reservable;
2696             my %borrowers;
2697             ITEM: foreach my $i (@itemnumbers) {
2698                 my $item = GetItem($i);
2699                 next if IsItemOnHoldAndFound($i);
2700                 for my $b (@borrowernumbers) {
2701                     my $borr = $borrowers{$b} //= Koha::Patrons->find( $b )->unblessed;
2702                     next unless IsAvailableForItemLevelRequest($item, $borr);
2703                     next unless CanItemBeReserved($b,$i);
2704
2705                     push @reservable, $i;
2706                     if (@reservable >= @borrowernumbers) {
2707                         $resfound = 0;
2708                         last ITEM;
2709                     }
2710                     last;
2711                 }
2712             }
2713         }
2714     }
2715     return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2716
2717     return ( 1, undef ) if $override_limit;
2718
2719     my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
2720     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2721         {   categorycode => $patron->categorycode,
2722             itemtype     => $item->{itype},
2723             branchcode   => $branchcode
2724         }
2725     );
2726
2727     return ( 0, "too_many" )
2728       if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2729
2730     my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2731     my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2732     $patron         = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2733     my $restricted  = $patron->is_debarred;
2734     my $hasoverdues = $patron->has_overdues;
2735
2736     if ( $restricted and $restrictionblockrenewing ) {
2737         return ( 0, 'restriction');
2738     } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2739         return ( 0, 'overdue');
2740     }
2741
2742     if ( $issue->auto_renew ) {
2743
2744         if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2745             return ( 0, 'auto_account_expired' );
2746         }
2747
2748         if ( defined $issuing_rule->no_auto_renewal_after
2749                 and $issuing_rule->no_auto_renewal_after ne "" ) {
2750             # Get issue_date and add no_auto_renewal_after
2751             # If this is greater than today, it's too late for renewal.
2752             my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2753             $maximum_renewal_date->add(
2754                 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2755             );
2756             my $now = dt_from_string;
2757             if ( $now >= $maximum_renewal_date ) {
2758                 return ( 0, "auto_too_late" );
2759             }
2760         }
2761         if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2762                       and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2763             # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2764             if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2765                 return ( 0, "auto_too_late" );
2766             }
2767         }
2768
2769         if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2770             my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2771             my $amountoutstanding = $patron->account->balance;
2772             if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2773                 return ( 0, "auto_too_much_oweing" );
2774             }
2775         }
2776     }
2777
2778     if ( defined $issuing_rule->norenewalbefore
2779         and $issuing_rule->norenewalbefore ne "" )
2780     {
2781
2782         # Calculate soonest renewal by subtracting 'No renewal before' from due date
2783         my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2784             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2785
2786         # Depending on syspref reset the exact time, only check the date
2787         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2788             and $issuing_rule->lengthunit eq 'days' )
2789         {
2790             $soonestrenewal->truncate( to => 'day' );
2791         }
2792
2793         if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2794         {
2795             return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2796             return ( 0, "too_soon" );
2797         }
2798         elsif ( $issue->auto_renew ) {
2799             return ( 0, "auto_renew" );
2800         }
2801     }
2802
2803     # Fallback for automatic renewals:
2804     # If norenewalbefore is undef, don't renew before due date.
2805     if ( $issue->auto_renew ) {
2806         my $now = dt_from_string;
2807         return ( 0, "auto_renew" )
2808           if $now >= dt_from_string( $issue->date_due, 'sql' );
2809         return ( 0, "auto_too_soon" );
2810     }
2811
2812     return ( 1, undef );
2813 }
2814
2815 =head2 AddRenewal
2816
2817   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2818
2819 Renews a loan.
2820
2821 C<$borrowernumber> is the borrower number of the patron who currently
2822 has the item.
2823
2824 C<$itemnumber> is the number of the item to renew.
2825
2826 C<$branch> is the library where the renewal took place (if any).
2827            The library that controls the circ policies for the renewal is retrieved from the issues record.
2828
2829 C<$datedue> can be a DateTime object used to set the due date.
2830
2831 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2832 this parameter is not supplied, lastreneweddate is set to the current date.
2833
2834 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2835 from the book's item type.
2836
2837 =cut
2838
2839 sub AddRenewal {
2840     my $borrowernumber  = shift;
2841     my $itemnumber      = shift or return;
2842     my $branch          = shift;
2843     my $datedue         = shift;
2844     my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2845
2846     my $item   = GetItem($itemnumber) or return;
2847     my $item_object = Koha::Items->find( $itemnumber ); # Should replace $item
2848     my $biblio = $item_object->biblio;
2849
2850     my $dbh = C4::Context->dbh;
2851
2852     # Find the issues record for this book
2853     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
2854
2855     return unless $issue;
2856
2857     $borrowernumber ||= $issue->borrowernumber;
2858
2859     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2860         carp 'Invalid date passed to AddRenewal.';
2861         return;
2862     }
2863
2864     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2865     my $patron_unblessed = $patron->unblessed;
2866
2867     if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2868         _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $patron_unblessed } );
2869     }
2870     _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2871
2872     # If the due date wasn't specified, calculate it by adding the
2873     # book's loan length to today's date or the current due date
2874     # based on the value of the RenewalPeriodBase syspref.
2875     unless ($datedue) {
2876
2877         my $itemtype = $item_object->effective_itemtype;
2878         $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2879                                         dt_from_string( $issue->date_due, 'sql' ) :
2880                                         DateTime->now( time_zone => C4::Context->tz());
2881         $datedue =  CalcDateDue($datedue, $itemtype, _GetCircControlBranch($item, $patron_unblessed), $patron_unblessed, 'is a renewal');
2882     }
2883
2884     # Update the issues record to have the new due date, and a new count
2885     # of how many times it has been renewed.
2886     my $renews = $issue->renewals + 1;
2887     my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2888                             WHERE borrowernumber=?
2889                             AND itemnumber=?"
2890     );
2891
2892     $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2893
2894     # Update the renewal count on the item, and tell zebra to reindex
2895     $renews = $item->{renewals} + 1;
2896     ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item->{biblionumber}, $itemnumber, { log_action => 0 } );
2897
2898     # Charge a new rental fee, if applicable?
2899     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2900     if ( $charge > 0 ) {
2901         my $accountno = C4::Accounts::getnextacctno( $borrowernumber );
2902         my $manager_id = 0;
2903         $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2904         my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2905         Koha::Account::Line->new(
2906             {
2907                 date              => dt_from_string(),
2908                 borrowernumber    => $borrowernumber,
2909                 accountno         => $accountno,
2910                 amount            => $charge,
2911                 manager_id        => $manager_id,
2912                 accounttype       => 'Rent',
2913                 amountoutstanding => $charge,
2914                 itemnumber        => $itemnumber,
2915                 branchcode        => $branchcode,
2916                 description       => 'Renewal of Rental Item '
2917                   . $biblio->title
2918                   . " $item->{'barcode'}",
2919             }
2920         )->store();
2921     }
2922
2923     # Send a renewal slip according to checkout alert preferencei
2924     if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2925         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2926         my %conditions        = (
2927             branchcode   => $branch,
2928             categorycode => $patron->categorycode,
2929             item_type    => $item->{itype},
2930             notification => 'CHECKOUT',
2931         );
2932         if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2933             SendCirculationAlert(
2934                 {
2935                     type     => 'RENEWAL',
2936                     item     => $item,
2937                     borrower => $patron->unblessed,
2938                     branch   => $branch,
2939                 }
2940             );
2941         }
2942     }
2943
2944     # Remove any OVERDUES related debarment if the borrower has no overdues
2945     if ( $patron
2946       && $patron->is_debarred
2947       && ! $patron->has_overdues
2948       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2949     ) {
2950         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2951     }
2952
2953     unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2954         $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2955     }
2956
2957     # Add the renewal to stats
2958     UpdateStats(
2959         {
2960             branch         => $branch,
2961             type           => 'renew',
2962             amount         => $charge,
2963             itemnumber     => $itemnumber,
2964             itemtype       => $item->{itype},
2965             location       => $item->{location},
2966             borrowernumber => $borrowernumber,
2967             ccode          => $item->{'ccode'}
2968         }
2969     );
2970
2971     #Log the renewal
2972     logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2973     return $datedue;
2974 }
2975
2976 sub GetRenewCount {
2977     # check renewal status
2978     my ( $bornum, $itemno ) = @_;
2979     my $dbh           = C4::Context->dbh;
2980     my $renewcount    = 0;
2981     my $renewsallowed = 0;
2982     my $renewsleft    = 0;
2983
2984     my $patron = Koha::Patrons->find( $bornum );
2985     my $item     = GetItem($itemno);
2986
2987     return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
2988
2989     # Look in the issues table for this item, lent to this borrower,
2990     # and not yet returned.
2991
2992     # FIXME - I think this function could be redone to use only one SQL call.
2993     my $sth = $dbh->prepare(
2994         "select * from issues
2995                                 where (borrowernumber = ?)
2996                                 and (itemnumber = ?)"
2997     );
2998     $sth->execute( $bornum, $itemno );
2999     my $data = $sth->fetchrow_hashref;
3000     $renewcount = $data->{'renewals'} if $data->{'renewals'};
3001     # $item and $borrower should be calculated
3002     my $branchcode = _GetCircControlBranch($item, $patron->unblessed);
3003
3004     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3005         {   categorycode => $patron->categorycode,
3006             itemtype     => $item->{itype},
3007             branchcode   => $branchcode
3008         }
3009     );
3010
3011     $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
3012     $renewsleft    = $renewsallowed - $renewcount;
3013     if($renewsleft < 0){ $renewsleft = 0; }
3014     return ( $renewcount, $renewsallowed, $renewsleft );
3015 }
3016
3017 =head2 GetSoonestRenewDate
3018
3019   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3020
3021 Find out the soonest possible renew date of a borrowed item.
3022
3023 C<$borrowernumber> is the borrower number of the patron who currently
3024 has the item on loan.
3025
3026 C<$itemnumber> is the number of the item to renew.
3027
3028 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3029 renew date, based on the value "No renewal before" of the applicable
3030 issuing rule. Returns the current date if the item can already be
3031 renewed, and returns undefined if the borrower, loan, or item
3032 cannot be found.
3033
3034 =cut
3035
3036 sub GetSoonestRenewDate {
3037     my ( $borrowernumber, $itemnumber ) = @_;
3038
3039     my $dbh = C4::Context->dbh;
3040
3041     my $item      = GetItem($itemnumber)      or return;
3042     my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
3043
3044     $borrowernumber ||= $itemissue->borrowernumber;
3045     my $patron = Koha::Patrons->find( $borrowernumber )
3046       or return;
3047
3048     my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
3049     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3050         {   categorycode => $patron->categorycode,
3051             itemtype     => $item->{itype},
3052             branchcode   => $branchcode
3053         }
3054     );
3055
3056     my $now = dt_from_string;
3057     return $now unless $issuing_rule;
3058
3059     if ( defined $issuing_rule->norenewalbefore
3060         and $issuing_rule->norenewalbefore ne "" )
3061     {
3062         my $soonestrenewal =
3063           dt_from_string( $itemissue->date_due )->subtract(
3064             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3065
3066         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3067             and $issuing_rule->lengthunit eq 'days' )
3068         {
3069             $soonestrenewal->truncate( to => 'day' );
3070         }
3071         return $soonestrenewal if $now < $soonestrenewal;
3072     }
3073     return $now;
3074 }
3075
3076 =head2 GetLatestAutoRenewDate
3077
3078   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3079
3080 Find out the latest possible auto renew date of a borrowed item.
3081
3082 C<$borrowernumber> is the borrower number of the patron who currently
3083 has the item on loan.
3084
3085 C<$itemnumber> is the number of the item to renew.
3086
3087 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3088 auto renew date, based on the value "No auto renewal after" and the "No auto
3089 renewal after (hard limit) of the applicable issuing rule.
3090 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3091 or item cannot be found.
3092
3093 =cut
3094
3095 sub GetLatestAutoRenewDate {
3096     my ( $borrowernumber, $itemnumber ) = @_;
3097
3098     my $dbh = C4::Context->dbh;
3099
3100     my $item      = GetItem($itemnumber)      or return;
3101     my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
3102
3103     $borrowernumber ||= $itemissue->borrowernumber;
3104     my $patron = Koha::Patrons->find( $borrowernumber )
3105       or return;
3106
3107     my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
3108     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3109         {   categorycode => $patron->categorycode,
3110             itemtype     => $item->{itype},
3111             branchcode   => $branchcode
3112         }
3113     );
3114
3115     return unless $issuing_rule;
3116     return
3117       if ( not $issuing_rule->no_auto_renewal_after
3118             or $issuing_rule->no_auto_renewal_after eq '' )
3119       and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3120              or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3121
3122     my $maximum_renewal_date;
3123     if ( $issuing_rule->no_auto_renewal_after ) {
3124         $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3125         $maximum_renewal_date->add(
3126             $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3127         );
3128     }
3129
3130     if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3131         my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3132         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3133     }
3134     return $maximum_renewal_date;
3135 }
3136
3137
3138 =head2 GetIssuingCharges
3139
3140   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3141
3142 Calculate how much it would cost for a given patron to borrow a given
3143 item, including any applicable discounts.
3144
3145 C<$itemnumber> is the item number of item the patron wishes to borrow.
3146
3147 C<$borrowernumber> is the patron's borrower number.
3148
3149 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3150 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3151 if it's a video).
3152
3153 =cut
3154
3155 sub GetIssuingCharges {
3156
3157     # calculate charges due
3158     my ( $itemnumber, $borrowernumber ) = @_;
3159     my $charge = 0;
3160     my $dbh    = C4::Context->dbh;
3161     my $item_type;
3162
3163     # Get the book's item type and rental charge (via its biblioitem).
3164     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3165         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3166     $charge_query .= (C4::Context->preference('item-level_itypes'))
3167         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3168         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3169
3170     $charge_query .= ' WHERE items.itemnumber =?';
3171
3172     my $sth = $dbh->prepare($charge_query);
3173     $sth->execute($itemnumber);
3174     if ( my $item_data = $sth->fetchrow_hashref ) {
3175         $item_type = $item_data->{itemtype};
3176         $charge    = $item_data->{rentalcharge};
3177         my $branch = C4::Context::mybranch();
3178         my $discount_query = q|SELECT rentaldiscount,
3179             issuingrules.itemtype, issuingrules.branchcode
3180             FROM borrowers
3181             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3182             WHERE borrowers.borrowernumber = ?
3183             AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3184             AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3185         my $discount_sth = $dbh->prepare($discount_query);
3186         $discount_sth->execute( $borrowernumber, $item_type, $branch );
3187         my $discount_rules = $discount_sth->fetchall_arrayref({});
3188         if (@{$discount_rules}) {
3189             # We may have multiple rules so get the most specific
3190             my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3191             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3192         }
3193         if ($charge) {
3194             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3195         }
3196     }
3197
3198     return ( $charge, $item_type );
3199 }
3200
3201 # Select most appropriate discount rule from those returned
3202 sub _get_discount_from_rule {
3203     my ($rules_ref, $branch, $itemtype) = @_;
3204     my $discount;
3205
3206     if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3207         $discount = $rules_ref->[0]->{rentaldiscount};
3208         return (defined $discount) ? $discount : 0;
3209     }
3210     # could have up to 4 does one match $branch and $itemtype
3211     my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3212     if (@d) {
3213         $discount = $d[0]->{rentaldiscount};
3214         return (defined $discount) ? $discount : 0;
3215     }
3216     # do we have item type + all branches
3217     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3218     if (@d) {
3219         $discount = $d[0]->{rentaldiscount};
3220         return (defined $discount) ? $discount : 0;
3221     }
3222     # do we all item types + this branch
3223     @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3224     if (@d) {
3225         $discount = $d[0]->{rentaldiscount};
3226         return (defined $discount) ? $discount : 0;
3227     }
3228     # so all and all (surely we wont get here)
3229     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3230     if (@d) {
3231         $discount = $d[0]->{rentaldiscount};
3232         return (defined $discount) ? $discount : 0;
3233     }
3234     # none of the above
3235     return 0;
3236 }
3237
3238 =head2 AddIssuingCharge
3239
3240   &AddIssuingCharge( $checkout, $charge )
3241
3242 =cut
3243
3244 sub AddIssuingCharge {
3245     my ( $checkout, $charge ) = @_;
3246
3247     # FIXME What if checkout does not exist?
3248
3249     my $nextaccntno = C4::Accounts::getnextacctno( $checkout->borrowernumber );
3250
3251     my $manager_id  = 0;
3252     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3253
3254     my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
3255
3256     my $accountline = Koha::Account::Line->new(
3257         {
3258             borrowernumber    => $checkout->borrowernumber,
3259             itemnumber        => $checkout->itemnumber,
3260             issue_id          => $checkout->issue_id,
3261             accountno         => $nextaccntno,
3262             amount            => $charge,
3263             amountoutstanding => $charge,
3264             manager_id        => $manager_id,
3265             branchcode        => $branchcode,
3266             description       => 'Rental',
3267             accounttype       => 'Rent',
3268             date              => \'NOW()',
3269         }
3270     )->store();
3271
3272     Koha::Account::Offset->new(
3273         {
3274             debit_id => $accountline->id,
3275             type     => 'Rental Fee',
3276             amount   => $charge,
3277         }
3278     )->store();
3279 }
3280
3281 =head2 GetTransfers
3282
3283   GetTransfers($itemnumber);
3284
3285 =cut
3286
3287 sub GetTransfers {
3288     my ($itemnumber) = @_;
3289
3290     my $dbh = C4::Context->dbh;
3291
3292     my $query = '
3293         SELECT datesent,
3294                frombranch,
3295                tobranch,
3296                branchtransfer_id
3297         FROM branchtransfers
3298         WHERE itemnumber = ?
3299           AND datearrived IS NULL
3300         ';
3301     my $sth = $dbh->prepare($query);
3302     $sth->execute($itemnumber);
3303     my @row = $sth->fetchrow_array();
3304     return @row;
3305 }
3306
3307 =head2 GetTransfersFromTo
3308
3309   @results = GetTransfersFromTo($frombranch,$tobranch);
3310
3311 Returns the list of pending transfers between $from and $to branch
3312
3313 =cut
3314
3315 sub GetTransfersFromTo {
3316     my ( $frombranch, $tobranch ) = @_;
3317     return unless ( $frombranch && $tobranch );
3318     my $dbh   = C4::Context->dbh;
3319     my $query = "
3320         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3321         FROM   branchtransfers
3322         WHERE  frombranch=?
3323           AND  tobranch=?
3324           AND datearrived IS NULL
3325     ";
3326     my $sth = $dbh->prepare($query);
3327     $sth->execute( $frombranch, $tobranch );
3328     my @gettransfers;
3329
3330     while ( my $data = $sth->fetchrow_hashref ) {
3331         push @gettransfers, $data;
3332     }
3333     return (@gettransfers);
3334 }
3335
3336 =head2 DeleteTransfer
3337
3338   &DeleteTransfer($itemnumber);
3339
3340 =cut
3341
3342 sub DeleteTransfer {
3343     my ($itemnumber) = @_;
3344     return unless $itemnumber;
3345     my $dbh          = C4::Context->dbh;
3346     my $sth          = $dbh->prepare(
3347         "DELETE FROM branchtransfers
3348          WHERE itemnumber=?
3349          AND datearrived IS NULL "
3350     );
3351     return $sth->execute($itemnumber);
3352 }
3353
3354 =head2 SendCirculationAlert
3355
3356 Send out a C<check-in> or C<checkout> alert using the messaging system.
3357
3358 B<Parameters>:
3359
3360 =over 4
3361
3362 =item type
3363
3364 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3365
3366 =item item
3367
3368 Hashref of information about the item being checked in or out.
3369
3370 =item borrower
3371
3372 Hashref of information about the borrower of the item.
3373
3374 =item branch
3375
3376 The branchcode from where the checkout or check-in took place.
3377
3378 =back
3379
3380 B<Example>:
3381
3382     SendCirculationAlert({
3383         type     => 'CHECKOUT',
3384         item     => $item,
3385         borrower => $borrower,
3386         branch   => $branch,
3387     });
3388
3389 =cut
3390
3391 sub SendCirculationAlert {
3392     my ($opts) = @_;
3393     my ($type, $item, $borrower, $branch) =
3394         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3395     my %message_name = (
3396         CHECKIN  => 'Item_Check_in',
3397         CHECKOUT => 'Item_Checkout',
3398         RENEWAL  => 'Item_Checkout',
3399     );
3400     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3401         borrowernumber => $borrower->{borrowernumber},
3402         message_name   => $message_name{$type},
3403     });
3404     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3405
3406     my $schema = Koha::Database->new->schema;
3407     my @transports = keys %{ $borrower_preferences->{transports} };
3408
3409     # From the MySQL doc:
3410     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3411     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3412     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3413     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3414
3415     for my $mtt (@transports) {
3416         my $letter =  C4::Letters::GetPreparedLetter (
3417             module => 'circulation',
3418             letter_code => $type,
3419             branchcode => $branch,
3420             message_transport_type => $mtt,
3421             lang => $borrower->{lang},
3422             tables => {
3423                 $issues_table => $item->{itemnumber},
3424                 'items'       => $item->{itemnumber},
3425                 'biblio'      => $item->{biblionumber},
3426                 'biblioitems' => $item->{biblionumber},
3427                 'borrowers'   => $borrower,
3428                 'branches'    => $branch,
3429             }
3430         ) or next;
3431
3432         $schema->storage->txn_begin;
3433         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3434         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3435         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3436         unless ( $message ) {
3437             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3438             C4::Message->enqueue($letter, $borrower, $mtt);
3439         } else {
3440             $message->append($letter);
3441             $message->update;
3442         }
3443         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3444         $schema->storage->txn_commit;
3445     }
3446
3447     return;
3448 }
3449
3450 =head2 updateWrongTransfer
3451
3452   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3453
3454 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
3455
3456 =cut
3457
3458 sub updateWrongTransfer {
3459         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3460         my $dbh = C4::Context->dbh;
3461 # first step validate the actual line of transfert .
3462         my $sth =
3463                 $dbh->prepare(
3464                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3465                 );
3466                 $sth->execute($FromLibrary,$itemNumber);
3467
3468 # second step create a new line of branchtransfer to the right location .
3469         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3470
3471 #third step changing holdingbranch of item
3472         UpdateHoldingbranch($FromLibrary,$itemNumber);
3473 }
3474
3475 =head2 UpdateHoldingbranch
3476
3477   $items = UpdateHoldingbranch($branch,$itmenumber);
3478
3479 Simple methode for updating hodlingbranch in items BDD line
3480
3481 =cut
3482
3483 sub UpdateHoldingbranch {
3484         my ( $branch,$itemnumber ) = @_;
3485     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3486 }
3487
3488 =head2 CalcDateDue
3489
3490 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3491
3492 this function calculates the due date given the start date and configured circulation rules,
3493 checking against the holidays calendar as per the 'useDaysMode' syspref.
3494 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3495 C<$itemtype>  = itemtype code of item in question
3496 C<$branch>  = location whose calendar to use
3497 C<$borrower> = Borrower object
3498 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3499
3500 =cut
3501
3502 sub CalcDateDue {
3503     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3504
3505     $isrenewal ||= 0;
3506
3507     # loanlength now a href
3508     my $loanlength =
3509             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3510
3511     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3512             ? qq{renewalperiod}
3513             : qq{issuelength};
3514
3515     my $datedue;
3516     if ( $startdate ) {
3517         if (ref $startdate ne 'DateTime' ) {
3518             $datedue = dt_from_string($datedue);
3519         } else {
3520             $datedue = $startdate->clone;
3521         }
3522     } else {
3523         $datedue =
3524           DateTime->now( time_zone => C4::Context->tz() )
3525           ->truncate( to => 'minute' );
3526     }
3527
3528
3529     # calculate the datedue as normal
3530     if ( C4::Context->preference('useDaysMode') eq 'Days' )
3531     {    # ignoring calendar
3532         if ( $loanlength->{lengthunit} eq 'hours' ) {
3533             $datedue->add( hours => $loanlength->{$length_key} );
3534         } else {    # days
3535             $datedue->add( days => $loanlength->{$length_key} );
3536             $datedue->set_hour(23);
3537             $datedue->set_minute(59);
3538         }
3539     } else {
3540         my $dur;
3541         if ($loanlength->{lengthunit} eq 'hours') {
3542             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3543         }
3544         else { # days
3545             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3546         }
3547         my $calendar = Koha::Calendar->new( branchcode => $branch );
3548         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3549         if ($loanlength->{lengthunit} eq 'days') {
3550             $datedue->set_hour(23);
3551             $datedue->set_minute(59);
3552         }
3553     }
3554
3555     # if Hard Due Dates are used, retrieve them and apply as necessary
3556     my ( $hardduedate, $hardduedatecompare ) =
3557       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3558     if ($hardduedate) {    # hardduedates are currently dates
3559         $hardduedate->truncate( to => 'minute' );
3560         $hardduedate->set_hour(23);
3561         $hardduedate->set_minute(59);
3562         my $cmp = DateTime->compare( $hardduedate, $datedue );
3563
3564 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3565 # if the calculated date is before the 'after' Hard Due Date (floor), override
3566 # if the hard due date is set to 'exactly', overrride
3567         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3568             $datedue = $hardduedate->clone;
3569         }
3570
3571         # in all other cases, keep the date due as it is
3572
3573     }
3574
3575     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3576     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3577         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3578         if( $expiry_dt ) { #skip empty expiry date..
3579             $expiry_dt->set( hour => 23, minute => 59);
3580             my $d1= $datedue->clone->set_time_zone('floating');
3581             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3582                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3583             }
3584         }
3585         if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3586           my $calendar = Koha::Calendar->new( branchcode => $branch );
3587           if ( $calendar->is_holiday($datedue) ) {
3588               # Don't return on a closed day
3589               $datedue = $calendar->prev_open_day( $datedue );
3590           }
3591         }
3592     }
3593
3594     return $datedue;
3595 }
3596
3597
3598 sub CheckValidBarcode{
3599 my ($barcode) = @_;
3600 my $dbh = C4::Context->dbh;
3601 my $query=qq|SELECT count(*)
3602              FROM items
3603              WHERE barcode=?
3604             |;
3605 my $sth = $dbh->prepare($query);
3606 $sth->execute($barcode);
3607 my $exist=$sth->fetchrow ;
3608 return $exist;
3609 }
3610
3611 =head2 IsBranchTransferAllowed
3612
3613   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3614
3615 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3616
3617 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3618 Koha::Item->can_be_transferred.
3619
3620 =cut
3621
3622 sub IsBranchTransferAllowed {
3623         my ( $toBranch, $fromBranch, $code ) = @_;
3624
3625         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3626
3627         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3628         my $dbh = C4::Context->dbh;
3629
3630         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3631         $sth->execute( $toBranch, $fromBranch, $code );
3632         my $limit = $sth->fetchrow_hashref();
3633
3634         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3635         if ( $limit->{'limitId'} ) {
3636                 return 0;
3637         } else {
3638                 return 1;
3639         }
3640 }
3641
3642 =head2 CreateBranchTransferLimit
3643
3644   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3645
3646 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3647
3648 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3649
3650 =cut
3651
3652 sub CreateBranchTransferLimit {
3653    my ( $toBranch, $fromBranch, $code ) = @_;
3654    return unless defined($toBranch) && defined($fromBranch);
3655    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3656
3657    my $dbh = C4::Context->dbh;
3658
3659    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3660    return $sth->execute( $code, $toBranch, $fromBranch );
3661 }
3662
3663 =head2 DeleteBranchTransferLimits
3664
3665     my $result = DeleteBranchTransferLimits($frombranch);
3666
3667 Deletes all the library transfer limits for one library.  Returns the
3668 number of limits deleted, 0e0 if no limits were deleted, or undef if
3669 no arguments are supplied.
3670
3671 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3672     fromBranch => $fromBranch
3673     })->delete.
3674
3675 =cut
3676
3677 sub DeleteBranchTransferLimits {
3678     my $branch = shift;
3679     return unless defined $branch;
3680     my $dbh    = C4::Context->dbh;
3681     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3682     return $sth->execute($branch);
3683 }
3684
3685 sub ReturnLostItem{
3686     my ( $borrowernumber, $itemnum ) = @_;
3687
3688     MarkIssueReturned( $borrowernumber, $itemnum );
3689     my $patron = Koha::Patrons->find( $borrowernumber );
3690     my $item = C4::Items::GetItem( $itemnum );
3691     my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3692     my @datearr = localtime(time);
3693     my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3694     my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3695     ModItem({ paidfor =>  $old_note."Paid for by $bor $date" }, undef, $itemnum);
3696 }
3697
3698
3699 sub LostItem{
3700     my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3701
3702     unless ( $mark_lost_from ) {
3703         # Temporary check to avoid regressions
3704         die q|LostItem called without $mark_lost_from, check the API.|;
3705     }
3706
3707     my $mark_returned;
3708     if ( $force_mark_returned ) {
3709         $mark_returned = 1;
3710     } else {
3711         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3712         $mark_returned = ( $pref =~ m|$mark_lost_from| );
3713     }
3714
3715     my $dbh = C4::Context->dbh();
3716     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3717                            FROM issues
3718                            JOIN items USING (itemnumber)
3719                            JOIN biblio USING (biblionumber)
3720                            WHERE issues.itemnumber=?");
3721     $sth->execute($itemnumber);
3722     my $issues=$sth->fetchrow_hashref();
3723
3724     # If a borrower lost the item, add a replacement cost to the their record
3725     if ( my $borrowernumber = $issues->{borrowernumber} ){
3726         my $patron = Koha::Patrons->find( $borrowernumber );
3727
3728         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 0); # 1, 0 = exemptfine, no-dropbox
3729         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3730
3731         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3732             C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'} $issues->{'itemcallnumber'}");
3733             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3734             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3735         }
3736
3737         MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$patron->privacy) if $mark_returned;
3738     }
3739
3740     #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3741     if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3742         ModItem({holdingbranch => $frombranch}, undef, $itemnumber);
3743     }
3744     my $transferdeleted = DeleteTransfer($itemnumber);
3745 }
3746
3747 sub GetOfflineOperations {
3748     my $dbh = C4::Context->dbh;
3749     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3750     $sth->execute(C4::Context->userenv->{'branch'});
3751     my $results = $sth->fetchall_arrayref({});
3752     return $results;
3753 }
3754
3755 sub GetOfflineOperation {
3756     my $operationid = shift;
3757     return unless $operationid;
3758     my $dbh = C4::Context->dbh;
3759     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3760     $sth->execute( $operationid );
3761     return $sth->fetchrow_hashref;
3762 }
3763
3764 sub AddOfflineOperation {
3765     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3766     my $dbh = C4::Context->dbh;
3767     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3768     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3769     return "Added.";
3770 }
3771
3772 sub DeleteOfflineOperation {
3773     my $dbh = C4::Context->dbh;
3774     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3775     $sth->execute( shift );
3776     return "Deleted.";
3777 }
3778
3779 sub ProcessOfflineOperation {
3780     my $operation = shift;
3781
3782     my $report;
3783     if ( $operation->{action} eq 'return' ) {
3784         $report = ProcessOfflineReturn( $operation );
3785     } elsif ( $operation->{action} eq 'issue' ) {
3786         $report = ProcessOfflineIssue( $operation );
3787     } elsif ( $operation->{action} eq 'payment' ) {
3788         $report = ProcessOfflinePayment( $operation );
3789     }
3790
3791     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3792
3793     return $report;
3794 }
3795
3796 sub ProcessOfflineReturn {
3797     my $operation = shift;
3798
3799     my $item = Koha::Items->find({barcode => $operation->{barcode}});
3800
3801     if ( $item ) {
3802         my $itemnumber = $item->itemnumber;
3803         my $issue = GetOpenIssue( $itemnumber );
3804         if ( $issue ) {
3805             MarkIssueReturned(
3806                 $issue->{borrowernumber},
3807                 $itemnumber,
3808                 undef,
3809                 $operation->{timestamp},
3810             );
3811             ModItem(
3812                 { renewals => 0, onloan => undef },
3813                 $issue->{'biblionumber'},
3814                 $itemnumber,
3815                 { log_action => 0 }
3816             );
3817             return "Success.";
3818         } else {
3819             return "Item not issued.";
3820         }
3821     } else {
3822         return "Item not found.";
3823     }
3824 }
3825
3826 sub ProcessOfflineIssue {
3827     my $operation = shift;
3828
3829     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3830
3831     if ( $patron ) {
3832         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3833         unless ($item) {
3834             return "Barcode not found.";
3835         }
3836         my $itemnumber = $item->itemnumber;
3837         my $issue = GetOpenIssue( $itemnumber );
3838
3839         if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3840             MarkIssueReturned(
3841                 $issue->{borrowernumber},
3842                 $itemnumber,
3843                 undef,
3844                 $operation->{timestamp},
3845             );
3846         }
3847         AddIssue(
3848             $patron->unblessed,
3849             $operation->{'barcode'},
3850             undef,
3851             1,
3852             $operation->{timestamp},
3853             undef,
3854         );
3855         return "Success.";
3856     } else {
3857         return "Borrower not found.";
3858     }
3859 }
3860
3861 sub ProcessOfflinePayment {
3862     my $operation = shift;
3863
3864     my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3865
3866     $patron->account->pay({ amount => $operation->{amount}, library_id => $operation->{branchcode} });
3867
3868     return "Success.";
3869 }
3870
3871 =head2 TransferSlip
3872
3873   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3874
3875   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3876
3877 =cut
3878
3879 sub TransferSlip {
3880     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3881
3882     my $item =  GetItem( $itemnumber, $barcode )
3883       or return;
3884
3885     return C4::Letters::GetPreparedLetter (
3886         module => 'circulation',
3887         letter_code => 'TRANSFERSLIP',
3888         branchcode => $branch,
3889         tables => {
3890             'branches'    => $to_branch,
3891             'biblio'      => $item->{biblionumber},
3892             'items'       => $item,
3893         },
3894     );
3895 }
3896
3897 =head2 CheckIfIssuedToPatron
3898
3899   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3900
3901   Return 1 if any record item is issued to patron, otherwise return 0
3902
3903 =cut
3904
3905 sub CheckIfIssuedToPatron {
3906     my ($borrowernumber, $biblionumber) = @_;
3907
3908     my $dbh = C4::Context->dbh;
3909     my $query = q|
3910         SELECT COUNT(*) FROM issues
3911         LEFT JOIN items ON items.itemnumber = issues.itemnumber
3912         WHERE items.biblionumber = ?
3913         AND issues.borrowernumber = ?
3914     |;
3915     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3916     return 1 if $is_issued;
3917     return;
3918 }
3919
3920 =head2 IsItemIssued
3921
3922   IsItemIssued( $itemnumber )
3923
3924   Return 1 if the item is on loan, otherwise return 0
3925
3926 =cut
3927
3928 sub IsItemIssued {
3929     my $itemnumber = shift;
3930     my $dbh = C4::Context->dbh;
3931     my $sth = $dbh->prepare(q{
3932         SELECT COUNT(*)
3933         FROM issues
3934         WHERE itemnumber = ?
3935     });
3936     $sth->execute($itemnumber);
3937     return $sth->fetchrow;
3938 }
3939
3940 =head2 GetAgeRestriction
3941
3942   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3943   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3944
3945   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3946   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3947
3948 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3949 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3950 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3951          Negative days mean the borrower has gone past the age restriction age.
3952
3953 =cut
3954
3955 sub GetAgeRestriction {
3956     my ($record_restrictions, $borrower) = @_;
3957     my $markers = C4::Context->preference('AgeRestrictionMarker');
3958
3959     # Split $record_restrictions to something like FSK 16 or PEGI 6
3960     my @values = split ' ', uc($record_restrictions);
3961     return unless @values;
3962
3963     # Search first occurrence of one of the markers
3964     my @markers = split /\|/, uc($markers);
3965     return unless @markers;
3966
3967     my $index            = 0;
3968     my $restriction_year = 0;
3969     for my $value (@values) {
3970         $index++;
3971         for my $marker (@markers) {
3972             $marker =~ s/^\s+//;    #remove leading spaces
3973             $marker =~ s/\s+$//;    #remove trailing spaces
3974             if ( $marker eq $value ) {
3975                 if ( $index <= $#values ) {
3976                     $restriction_year += $values[$index];
3977                 }
3978                 last;
3979             }
3980             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3981
3982                 # Perhaps it is something like "K16" (as in Finland)
3983                 $restriction_year += $1;
3984                 last;
3985             }
3986         }
3987         last if ( $restriction_year > 0 );
3988     }
3989
3990     #Check if the borrower is age restricted for this material and for how long.
3991     if ($restriction_year && $borrower) {
3992         if ( $borrower->{'dateofbirth'} ) {
3993             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3994             $alloweddate[0] += $restriction_year;
3995
3996             #Prevent runime eror on leap year (invalid date)
3997             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3998                 $alloweddate[2] = 28;
3999             }
4000
4001             #Get how many days the borrower has to reach the age restriction
4002             my @Today = split /-/, DateTime->today->ymd();
4003             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4004             #Negative days means the borrower went past the age restriction age
4005             return ($restriction_year, $daysToAgeRestriction);
4006         }
4007     }
4008
4009     return ($restriction_year);
4010 }
4011
4012
4013 =head2 GetPendingOnSiteCheckouts
4014
4015 =cut
4016
4017 sub GetPendingOnSiteCheckouts {
4018     my $dbh = C4::Context->dbh;
4019     return $dbh->selectall_arrayref(q|
4020         SELECT
4021           items.barcode,
4022           items.biblionumber,
4023           items.itemnumber,
4024           items.itemnotes,
4025           items.itemcallnumber,
4026           items.location,
4027           issues.date_due,
4028           issues.branchcode,
4029           issues.date_due < NOW() AS is_overdue,
4030           biblio.author,
4031           biblio.title,
4032           borrowers.firstname,
4033           borrowers.surname,
4034           borrowers.cardnumber,
4035           borrowers.borrowernumber
4036         FROM items
4037         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4038         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4039         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4040         WHERE issues.onsite_checkout = 1
4041     |, { Slice => {} } );
4042 }
4043
4044 sub GetTopIssues {
4045     my ($params) = @_;
4046
4047     my ($count, $branch, $itemtype, $ccode, $newness)
4048         = @$params{qw(count branch itemtype ccode newness)};
4049
4050     my $dbh = C4::Context->dbh;
4051     my $query = q{
4052         SELECT * FROM (
4053         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4054           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4055           i.ccode, SUM(i.issues) AS count
4056         FROM biblio b
4057         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4058         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4059     };
4060
4061     my (@where_strs, @where_args);
4062
4063     if ($branch) {
4064         push @where_strs, 'i.homebranch = ?';
4065         push @where_args, $branch;
4066     }
4067     if ($itemtype) {
4068         if (C4::Context->preference('item-level_itypes')){
4069             push @where_strs, 'i.itype = ?';
4070             push @where_args, $itemtype;
4071         } else {
4072             push @where_strs, 'bi.itemtype = ?';
4073             push @where_args, $itemtype;
4074         }
4075     }
4076     if ($ccode) {
4077         push @where_strs, 'i.ccode = ?';
4078         push @where_args, $ccode;
4079     }
4080     if ($newness) {
4081         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4082         push @where_args, $newness;
4083     }
4084
4085     if (@where_strs) {
4086         $query .= 'WHERE ' . join(' AND ', @where_strs);
4087     }
4088
4089     $query .= q{
4090         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4091           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4092           i.ccode
4093         ORDER BY count DESC
4094     };
4095
4096     $query .= q{ ) xxx WHERE count > 0 };
4097     $count = int($count);
4098     if ($count > 0) {
4099         $query .= "LIMIT $count";
4100     }
4101
4102     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4103
4104     return @$rows;
4105 }
4106
4107 sub _CalculateAndUpdateFine {
4108     my ($params) = @_;
4109
4110     my $borrower    = $params->{borrower};
4111     my $item        = $params->{item};
4112     my $issue       = $params->{issue};
4113     my $return_date = $params->{return_date};
4114
4115     unless ($borrower) { carp "No borrower passed in!" && return; }
4116     unless ($item)     { carp "No item passed in!"     && return; }
4117     unless ($issue)    { carp "No issue passed in!"    && return; }
4118
4119     my $datedue = dt_from_string( $issue->date_due );
4120
4121     # we only need to calculate and change the fines if we want to do that on return
4122     # Should be on for hourly loans
4123     my $control = C4::Context->preference('CircControl');
4124     my $control_branchcode =
4125         ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4126       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4127       :                                     $issue->branchcode;
4128
4129     my $date_returned = $return_date ? dt_from_string($return_date) : dt_from_string();
4130
4131     my ( $amount, $unitcounttotal, $unitcount  ) =
4132       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4133
4134     if ( C4::Context->preference('finesMode') eq 'production' ) {
4135         if ( $amount > 0 ) {
4136             C4::Overdues::UpdateFine({
4137                 issue_id       => $issue->issue_id,
4138                 itemnumber     => $issue->itemnumber,
4139                 borrowernumber => $issue->borrowernumber,
4140                 amount         => $amount,
4141                 due            => output_pref($datedue),
4142             });
4143         }
4144         elsif ($return_date) {
4145
4146             # Backdated returns may have fines that shouldn't exist,
4147             # so in this case, we need to drop those fines to 0
4148
4149             C4::Overdues::UpdateFine({
4150                 issue_id       => $issue->issue_id,
4151                 itemnumber     => $issue->itemnumber,
4152                 borrowernumber => $issue->borrowernumber,
4153                 amount         => 0,
4154                 due            => output_pref($datedue),
4155             });
4156         }
4157     }
4158 }
4159
4160 sub _item_denied_renewal {
4161     my ($params) = @_;
4162
4163     my $item = $params->{item};
4164     return unless $item;
4165
4166     my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4167     return unless $denyingrules;
4168     foreach my $field (keys %$denyingrules) {
4169         my $val = $item->{$field};
4170         if( !defined $val) {
4171             if ( any { !defined $_ }  @{$denyingrules->{$field}} ){
4172                 return 1;
4173             }
4174         } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4175            # If the results matches the values in the syspref
4176            # We return true if match found
4177             return 1;
4178         }
4179     }
4180     return 0;
4181 }
4182
4183
4184 1;
4185
4186 __END__
4187
4188 =head1 AUTHOR
4189
4190 Koha Development Team <http://koha-community.org/>
4191
4192 =cut